✕

OpenAPI Physical Model

Schema for:

Model name: petstore
Author:
Version:
File name: SAMPLE - OPENAPI - petstore_model.hck.json
File path: /Users/rvanbruggen/Library/CloudStorage/OneDrive-Hackolade/Demo/HackoladeGithubRepo/2-SAMPLE MODELS/SAMPLE - OPENAPI - petstore_model.hck.json
Printed On: Wed Jun 07 2023 15:38:33 GMT+0200 (Central European Summer Time)
Created with: Hackolade - Polyglot data modeling for NoSQL databases, storage formats, REST APIs, and JSON in RDBMS
1. Model
2. Resources
1. Model
1.1 Model petstore
1.1.1 petstore Entity Relationship Diagram
1.1.2 petstore Properties
1.1.2.1 Details tab
PropertyValue
Model namepetstore
Technical name
Description

This is a sample server Petstore server. You can find out more about Swagger at http://swagger.io or on irc.freenode.net, #swagger. For this sample, you can use the api key special-key to test the authorization filters.

Synchronization Id
TargetOpenAPI
Target version3.0.0
info
titleSwagger Petstore
terms of servicehttp://swagger.io/terms/
contact
name
url
emailapiteam@swagger.io
extensions
license
nameApache 2.0
urlhttp://www.apache.org/licenses/LICENSE-2.0.html
extensions
version1.0.0
info extensions
servers
[1] urlhttp://petstore.swagger.io/v2
description
variables
extensions
security
tags
[1] namepets
description

Everything about your Pets

externalDocs
extensions
[2] namestores
description

Find out more

externalDocs
extensions
[3] nameusers
description

More about users

externalDocs
extensions
externalDocs
urlhttp://swagger.io
description

Find out more about Swagger

extensions
extensions
[1] patternx-origin
value { "url": "http://petstore.swagger.io/v2/swagger.json", "format": "swagger", "version": "2.0", "converter": { "url": "https://github.com/mermade/swagger2openapi", "version": "2.2.0" } }
Lineage capture
Polyglot models
Comments
1.1.3 petstore Components
1.1.3.1 Field schemas
1.1.3.1.1 schemas Hierarchy
Parent field: Definitions
Child field(s):
FieldTypeReqKeyDescriptionComments
Orderobjectfalse
Categoryobjectfalse
Userobjectfalse
Tagobjectfalse
Petobjectfalse
ApiResponseobjectfalse
1.1.3.1.2 schemas properties
PropertyValue
Name schemas
Technical name
Type componentObject
1.1.3.2 Field Order
1.1.3.2.1 Order Hierarchy
Parent field: schemas
Child field(s):
FieldTypeReqKeyDescriptionComments
idintegerfalse
petIdintegerfalse
quantityintegerfalse
shipDatestringfalse
statusstringfalse

Order Status

completebooleanfalse
1.1.3.2.2 Order properties
PropertyValue
Name Order
Technical name Order
Id
Type object
Title
Description
Required
Deprecated
Allow empty value
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
nullable
Discriminator
readOnly
writeOnly
xml
name
namespace
prefix
attribute
wrapped
extensions
externalDocs
example (deprecated)
extensions
Comments
1.1.3.3 Field id
1.1.3.3.1 id properties
PropertyValue
Name id
Technical name id
Activated true
Id
Type integer
Format int64
Title
Description
Primary key false
Required
Deprecated
Default
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Faker function
example (deprecated)
nullable
readOnly
Foreign definition
Foreign field
Relationship type
Relationship name
Cardinality
xml
externalDocs
Comments
1.1.3.4 Field petId
1.1.3.4.1 petId properties
PropertyValue
Name petId
Technical name petId
Activated true
Id
Type integer
Format int64
Title
Description
Primary key false
Required
Deprecated
Default
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Faker function
example (deprecated)
nullable
readOnly
Foreign definition
Foreign field
Relationship type
Relationship name
Cardinality
xml
externalDocs
Comments
1.1.3.5 Field quantity
1.1.3.5.1 quantity properties
PropertyValue
Name quantity
Technical name quantity
Activated true
Id
Type integer
Format int32
Title
Description
Primary key false
Required
Deprecated
Default
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Faker function
example (deprecated)
nullable
readOnly
Foreign definition
Foreign field
Relationship type
Relationship name
Cardinality
xml
externalDocs
Comments
1.1.3.6 Field shipDate
1.1.3.6.1 shipDate properties
PropertyValue
Name shipDate
Technical name shipDate
Activated true
Id
Type string
Format date-time
Title
Description
Primary key false
Required
Deprecated
Default
Min length
Max length
Pattern
Enum
Faker function
example (deprecated)
nullable
readOnly
writeOnly
Foreign definition
Foreign field
Relationship type
Relationship name
Cardinality
xml
externalDocs
Comments
1.1.3.7 Field status
1.1.3.7.1 status properties
PropertyValue
Name status
Technical name status
Activated true
Id
Type string
Format
Title
Description

Order Status

Primary key false
Required
Deprecated
Default
Min length
Max length
Pattern
Enum placed,approved,delivered
Faker function
example (deprecated)
nullable
readOnly
writeOnly
Foreign definition
Foreign field
Relationship type
Relationship name
Cardinality
xml
externalDocs
Comments
1.1.3.8 Field complete
1.1.3.8.1 complete properties
PropertyValue
Name complete
Technical name complete
Activated true
Id
Type boolean
Title
Description
Primary key false
Required
Deprecated
Default false
Foreign definition
Foreign field
Relationship type
Relationship name
Cardinality
example (deprecated)
nullable
readOnly
writeOnly
Comments
1.1.3.9 Field Category
1.1.3.9.1 Category Hierarchy
Parent field: schemas
Child field(s):
FieldTypeReqKeyDescriptionComments
idintegerfalse
namestringfalse
1.1.3.9.2 Category properties
PropertyValue
Name Category
Technical name Category
Id
Type object
Title
Description
Required
Deprecated
Allow empty value
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
nullable
Discriminator
readOnly
writeOnly
xml
name
namespace
prefix
attribute
wrapped
extensions
externalDocs
example (deprecated)
extensions
Comments
1.1.3.10 Field id
1.1.3.10.1 id properties
PropertyValue
Name id
Technical name id
Activated true
Id
Type integer
Format int64
Title
Description
Primary key false
Required
Deprecated
Default
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Faker function
example (deprecated)
nullable
readOnly
Foreign definition
Foreign field
Relationship type
Relationship name
Cardinality
xml
externalDocs
Comments
1.1.3.11 Field name
1.1.3.11.1 name properties
PropertyValue
Name name
Technical name name
Activated true
Id
Type string
Format
Title
Description
Primary key false
Required
Deprecated
Default
Min length
Max length
Pattern
Enum
Faker function
example (deprecated)
nullable
readOnly
writeOnly
Foreign definition
Foreign field
Relationship type
Relationship name
Cardinality
xml
externalDocs
Comments
1.1.3.12 Field User
1.1.3.12.1 User Hierarchy
Parent field: schemas
Child field(s):
FieldTypeReqKeyDescriptionComments
idintegerfalse
usernamestringfalse
firstNamestringfalse
lastNamestringfalse
emailstringfalse
passwordstringfalse
phonestringfalse
userStatusintegerfalse

User Status

1.1.3.12.2 User properties
PropertyValue
Name User
Technical name User
Id
Type object
Title
Description
Required
Deprecated
Allow empty value
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
nullable
Discriminator
readOnly
writeOnly
xml
name
namespace
prefix
attribute
wrapped
extensions
externalDocs
example (deprecated)
extensions
Comments
1.1.3.13 Field id
1.1.3.13.1 id properties
PropertyValue
Name id
Technical name id
Activated true
Id
Type integer
Format int64
Title
Description
Primary key false
Required
Deprecated
Default
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Faker function
example (deprecated)
nullable
readOnly
Foreign definition
Foreign field
Relationship type
Relationship name
Cardinality
xml
externalDocs
Comments
1.1.3.14 Field username
1.1.3.14.1 username properties
PropertyValue
Name username
Technical name username
Activated true
Id
Type string
Format
Title
Description
Primary key false
Required
Deprecated
Default
Min length
Max length
Pattern
Enum
Faker function
example (deprecated)
nullable
readOnly
writeOnly
Foreign definition
Foreign field
Relationship type
Relationship name
Cardinality
xml
externalDocs
Comments
1.1.3.15 Field firstName
1.1.3.15.1 firstName properties
PropertyValue
Name firstName
Technical name firstName
Activated true
Id
Type string
Format
Title
Description
Primary key false
Required
Deprecated
Default
Min length
Max length
Pattern
Enum
Faker function
example (deprecated)
nullable
readOnly
writeOnly
Foreign definition
Foreign field
Relationship type
Relationship name
Cardinality
xml
externalDocs
Comments
1.1.3.16 Field lastName
1.1.3.16.1 lastName properties
PropertyValue
Name lastName
Technical name lastName
Activated true
Id
Type string
Format
Title
Description
Primary key false
Required
Deprecated
Default
Min length
Max length
Pattern
Enum
Faker function
example (deprecated)
nullable
readOnly
writeOnly
Foreign definition
Foreign field
Relationship type
Relationship name
Cardinality
xml
externalDocs
Comments
1.1.3.17 Field email
1.1.3.17.1 email properties
PropertyValue
Name email
Technical name email
Activated true
Id
Type string
Format
Title
Description
Primary key false
Required
Deprecated
Default
Min length
Max length
Pattern
Enum
Faker function
example (deprecated)
nullable
readOnly
writeOnly
Foreign definition
Foreign field
Relationship type
Relationship name
Cardinality
xml
externalDocs
Comments
1.1.3.18 Field password
1.1.3.18.1 password properties
PropertyValue
Name password
Technical name password
Activated true
Id
Type string
Format
Title
Description
Primary key false
Required
Deprecated
Default
Min length
Max length
Pattern
Enum
Faker function
example (deprecated)
nullable
readOnly
writeOnly
Foreign definition
Foreign field
Relationship type
Relationship name
Cardinality
xml
externalDocs
Comments
1.1.3.19 Field phone
1.1.3.19.1 phone properties
PropertyValue
Name phone
Technical name phone
Activated true
Id
Type string
Format
Title
Description
Primary key false
Required
Deprecated
Default
Min length
Max length
Pattern
Enum
Faker function
example (deprecated)
nullable
readOnly
writeOnly
Foreign definition
Foreign field
Relationship type
Relationship name
Cardinality
xml
externalDocs
Comments
1.1.3.20 Field userStatus
1.1.3.20.1 userStatus properties
PropertyValue
Name userStatus
Technical name userStatus
Activated true
Id
Type integer
Format int32
Title
Description

User Status

Primary key false
Required
Deprecated
Default
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Faker function
example (deprecated)
nullable
readOnly
Foreign definition
Foreign field
Relationship type
Relationship name
Cardinality
xml
externalDocs
Comments
1.1.3.21 Field Tag
1.1.3.21.1 Tag Hierarchy
Parent field: schemas
Child field(s):
FieldTypeReqKeyDescriptionComments
idintegerfalse
namestringfalse
1.1.3.21.2 Tag properties
PropertyValue
Name Tag
Technical name Tag
Id
Type object
Title
Description
Required
Deprecated
Allow empty value
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
nullable
Discriminator
readOnly
writeOnly
xml
name
namespace
prefix
attribute
wrapped
extensions
externalDocs
example (deprecated)
extensions
Comments
1.1.3.22 Field id
1.1.3.22.1 id properties
PropertyValue
Name id
Technical name id
Activated true
Id
Type integer
Format int64
Title
Description
Primary key false
Required
Deprecated
Default
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Faker function
example (deprecated)
nullable
readOnly
Foreign definition
Foreign field
Relationship type
Relationship name
Cardinality
xml
externalDocs
Comments
1.1.3.23 Field name
1.1.3.23.1 name properties
PropertyValue
Name name
Technical name name
Activated true
Id
Type string
Format
Title
Description
Primary key false
Required
Deprecated
Default
Min length
Max length
Pattern
Enum
Faker function
example (deprecated)
nullable
readOnly
writeOnly
Foreign definition
Foreign field
Relationship type
Relationship name
Cardinality
xml
externalDocs
Comments
1.1.3.24 Field Pet
1.1.3.24.1 Pet Hierarchy
Parent field: schemas
Child field(s):
FieldTypeReqKeyDescriptionComments
idintegerfalse
categorystringfalse
namestringtrue
photoUrlsarraytrue
tagsarrayfalse
statusstringfalse

pet status in the store

1.1.3.24.2 Pet properties
PropertyValue
Name Pet
Technical name Pet
Id
Type object
Title
Description
Required
Deprecated
Allow empty value
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
nullable
Discriminator
readOnly
writeOnly
xml
name
namespace
prefix
attribute
wrapped
extensions
externalDocs
example (deprecated)
extensions
Comments
1.1.3.25 Field id
1.1.3.25.1 id properties
PropertyValue
Name id
Technical name id
Activated true
Id
Type integer
Format int64
Title
Description
Primary key false
Required
Deprecated
Default
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Faker function
example (deprecated)
nullable
readOnly
Foreign definition
Foreign field
Relationship type
Relationship name
Cardinality
xml
externalDocs
Comments
1.1.3.26 Field category
1.1.3.26.1 category properties
PropertyValue
Name category
Technical name category
Activated true
Id
Type string
Format
Title
Description
Reference description
Primary key false
Required
Deprecated
Default
Min length
Max length
Pattern
Enum
Faker function
example (deprecated)
nullable
readOnly
writeOnly
Foreign definition
Foreign field
Relationship type
Relationship name
Cardinality
xml
externalDocs
Comments
1.1.3.27 Field name
1.1.3.27.1 name properties
PropertyValue
Name name
Technical name name
Activated true
Id
Type string
Format
Title
Description
Primary key false
Required true
Deprecated
Default
Min length
Max length
Pattern
Enum
Faker function
example (deprecated)
nullable
readOnly
writeOnly
Foreign definition
Foreign field
Relationship type
Relationship name
Cardinality
xml
externalDocs
Comments
1.1.3.28 Field photoUrls
1.1.3.28.1 photoUrls Hierarchy
Parent field: Pet
Child field(s):
FieldTypeReqKeyDescriptionComments
[0]stringfalse
1.1.3.28.2 photoUrls properties
PropertyValue
Name photoUrls
Technical name photoUrls
Activated true
Id
Type array
Title
Description
Required true
Min items
Max items
Unique items
Additional items true
nullable
readOnly
writeOnly
xml
name
namespace
prefix
attribute
wrapped
extensions
externalDocs
collectionFormat
example (deprecated)
Comments
1.1.3.29 Field [0]
1.1.3.29.1 [0] properties
PropertyValue
Display name
Activated true
Id
Type string
Format
Title
Description
Primary key false
Deprecated
Default
Min length
Max length
Pattern
Enum
Faker function
example (deprecated)
nullable
readOnly
writeOnly
Foreign definition
Foreign field
Relationship type
Relationship name
Cardinality
xml
externalDocs
Comments
1.1.3.30 Field tags
1.1.3.30.1 tags Hierarchy
Parent field: Pet
Child field(s):
FieldTypeReqKeyDescriptionComments
[0]stringfalse
1.1.3.30.2 tags properties
PropertyValue
Name tags
Technical name tags
Activated true
Id
Type array
Title
Description
Required
Min items
Max items
Unique items
Additional items true
nullable
readOnly
writeOnly
xml
name
namespace
prefix
attribute
wrapped
extensions
externalDocs
collectionFormat
example (deprecated)
Comments
1.1.3.31 Field [0]
1.1.3.31.1 [0] properties
PropertyValue
Display name
Activated true
Id
Type string
Format
Title
Description
Reference description
Primary key false
Deprecated
Default
Min length
Max length
Pattern
Enum
Faker function
example (deprecated)
nullable
readOnly
writeOnly
Foreign definition
Foreign field
Relationship type
Relationship name
Cardinality
xml
externalDocs
Comments
1.1.3.32 Field status
1.1.3.32.1 status properties
PropertyValue
Name status
Technical name status
Activated true
Id
Type string
Format
Title
Description

pet status in the store

Primary key false
Required
Deprecated
Default
Min length
Max length
Pattern
Enum available,pending,sold
Faker function
example (deprecated)
nullable
readOnly
writeOnly
Foreign definition
Foreign field
Relationship type
Relationship name
Cardinality
xml
externalDocs
Comments
1.1.3.33 Field ApiResponse
1.1.3.33.1 ApiResponse Hierarchy
Parent field: schemas
Child field(s):
FieldTypeReqKeyDescriptionComments
codeintegerfalse
typestringfalse
messagestringfalse
1.1.3.33.2 ApiResponse properties
PropertyValue
Name ApiResponse
Technical name ApiResponse
Id
Type object
Title
Description
Required
Deprecated
Allow empty value
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
nullable
Discriminator
readOnly
writeOnly
xml
externalDocs
example (deprecated)
extensions
Comments
1.1.3.34 Field code
1.1.3.34.1 code properties
PropertyValue
Name code
Technical name code
Activated true
Id
Type integer
Format int32
Title
Description
Primary key false
Required
Deprecated
Default
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Faker function
example (deprecated)
nullable
readOnly
Foreign definition
Foreign field
Relationship type
Relationship name
Cardinality
xml
externalDocs
Comments
1.1.3.35 Field type
1.1.3.35.1 type properties
PropertyValue
Name type
Technical name type
Activated true
Id
Type string
Format
Title
Description
Primary key false
Required
Deprecated
Default
Min length
Max length
Pattern
Enum
Faker function
example (deprecated)
nullable
readOnly
writeOnly
Foreign definition
Foreign field
Relationship type
Relationship name
Cardinality
xml
externalDocs
Comments
1.1.3.36 Field message
1.1.3.36.1 message properties
PropertyValue
Name message
Technical name message
Activated true
Id
Type string
Format
Title
Description
Primary key false
Required
Deprecated
Default
Min length
Max length
Pattern
Enum
Faker function
example (deprecated)
nullable
readOnly
writeOnly
Foreign definition
Foreign field
Relationship type
Relationship name
Cardinality
xml
externalDocs
Comments
1.1.3.37 Field responses
1.1.3.37.1 responses properties
PropertyValue
Name responses
Technical name
Type componentObject
1.1.3.38 Field parameters
1.1.3.38.1 parameters properties
PropertyValue
Name parameters
Technical name
Type componentObject
1.1.3.39 Field examples
1.1.3.39.1 examples properties
PropertyValue
Name examples
Technical name
Type componentObject
1.1.3.40 Field requestBodies
1.1.3.40.1 requestBodies Hierarchy
Parent field: Definitions
Child field(s):
FieldTypeReqKeyDescriptionComments
PetrequestBodytrue

Pet object that needs to be added to the store

UserArrayrequestBodytrue

List of user object

1.1.3.40.2 requestBodies properties
PropertyValue
Name requestBodies
Technical name
Type componentObject
1.1.3.41 Field Pet
1.1.3.41.1 Pet Hierarchy
Parent field: requestBodies
Child field(s):
FieldTypeReqKeyDescriptionComments
application/jsonmediafalse
application/xmlmediafalse
1.1.3.41.2 Pet properties
PropertyValue
Name Pet
Technical name Pet
Comments
Type requestBody
Required true
Description

Pet object that needs to be added to the store

extensions
1.1.3.42 Field application/json
1.1.3.42.1 application/json Hierarchy
Parent field: Pet
Child field(s):
FieldTypeReqKeyDescriptionComments
schemareferencefalse
examplesobjectfalse
encodingobjectfalse
1.1.3.42.2 application/json properties
PropertyValue
Name application/json
Activated true
Description
Comments
example
Type media
extensions
1.1.3.43 Field schema
1.1.3.43.1 schema properties
PropertyValue
Name schema
Technical name schema
Activated true
Reference type model
Reference description
1.1.3.44 Field examples
1.1.3.44.1 examples properties
PropertyValue
Name examples
Technical name examples
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
1.1.3.45 Field encoding
1.1.3.45.1 encoding properties
PropertyValue
Name encoding
Technical name encoding
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
1.1.3.46 Field application/xml
1.1.3.46.1 application/xml Hierarchy
Parent field: Pet
Child field(s):
FieldTypeReqKeyDescriptionComments
schemareferencefalse
examplesobjectfalse
encodingobjectfalse
1.1.3.46.2 application/xml properties
PropertyValue
Name application/xml
Activated true
Description
Comments
example
Type media
extensions
1.1.3.47 Field schema
1.1.3.47.1 schema properties
PropertyValue
Name schema
Technical name schema
Activated true
Reference type model
Reference description
1.1.3.48 Field examples
1.1.3.48.1 examples properties
PropertyValue
Name examples
Technical name examples
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
1.1.3.49 Field encoding
1.1.3.49.1 encoding properties
PropertyValue
Name encoding
Technical name encoding
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
1.1.3.50 Field UserArray
1.1.3.50.1 UserArray Hierarchy
Parent field: requestBodies
Child field(s):
FieldTypeReqKeyDescriptionComments
application/jsonmediafalse
1.1.3.50.2 UserArray properties
PropertyValue
Name UserArray
Technical name UserArray
Comments
Type requestBody
Required true
Description

List of user object

extensions
1.1.3.51 Field application/json
1.1.3.51.1 application/json Hierarchy
Parent field: UserArray
Child field(s):
FieldTypeReqKeyDescriptionComments
schemaarrayfalse
examplesobjectfalse
encodingobjectfalse
1.1.3.51.2 application/json properties
PropertyValue
Name application/json
Activated true
Description
Comments
example
Type media
extensions
1.1.3.52 Field schema
1.1.3.52.1 schema Hierarchy
Parent field: application/json
Child field(s):
FieldTypeReqKeyDescriptionComments
[0]referencefalse
1.1.3.52.2 schema properties
PropertyValue
Name schema
Technical name schema
Activated true
Id
Type array
Title
Description
Required
Min items
Max items
Unique items
Additional items true
nullable
readOnly
writeOnly
xml
externalDocs
collectionFormat
example (deprecated)
Comments
1.1.3.53 Field [0]
1.1.3.53.1 [0] properties
PropertyValue
Name
Activated true
Reference type model
Reference description
1.1.3.54 Field examples
1.1.3.54.1 examples properties
PropertyValue
Name examples
Technical name examples
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
1.1.3.55 Field encoding
1.1.3.55.1 encoding properties
PropertyValue
Name encoding
Technical name encoding
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
1.1.3.56 Field headers
1.1.3.56.1 headers properties
PropertyValue
Name headers
Technical name
Type componentObject
1.1.3.57 Field securitySchemes
1.1.3.57.1 securitySchemes Hierarchy
Parent field: Definitions
Child field(s):
FieldTypeReqKeyDescriptionComments
petstore_authsecuritySchemefalse
api_keysecuritySchemefalse
1.1.3.57.2 securitySchemes properties
PropertyValue
Name securitySchemes
Technical name
Type componentObject
1.1.3.58 Field petstore_auth
1.1.3.58.1 petstore_auth properties
PropertyValue
Name petstore_auth
Technical name petstore_auth
Description
Comments
Subtype oauth2
flows
implicit
authorizationUrlhttp://petstore.swagger.io/oauth/dialog
refreshUrl
scopes
[1] namewrite:pets
descriptionmodify pets in your account
[2] nameread:pets
descriptionread your pets
extensions
password
clientCredentials
authorizationCode
extensions
extensions
1.1.3.59 Field api_key
1.1.3.59.1 api_key properties
PropertyValue
Name api_key
Technical name api_key
Description
Comments
Subtype apiKey
apiKey name api_key
in header
extensions
1.1.3.60 Field links
1.1.3.60.1 links properties
PropertyValue
Name links
Technical name
Type componentObject
1.1.3.61 Field callbacks
1.1.3.61.1 callbacks Hierarchy
Parent field: Definitions
Child field(s):
FieldTypeReqKeyDescriptionComments
myEventcallbackfalse
1.1.3.61.2 callbacks properties
PropertyValue
Name callbacks
Technical name
Type componentObject
1.1.3.62 Field myEvent
1.1.3.62.1 myEvent properties
PropertyValue
Name myEvent
Technical name
Callback expression {$request.body#/callbackUrl}'
Resource 59cd2390-9c25-11e9-8b46-f5ec5f7b4bd7
Type callback
Description
Comments
extensions
1.1.3.63 Field Specification Extensions
1.1.3.63.1 Specification Extensions properties
PropertyValue
Name Specification Extensions
extensions
1.1.4 petstore OpenAPI File
{
  "openapi": "3.0.0",
  "info": {
    "title": "Swagger Petstore",
    "description": "This is a sample server Petstore server.  You can find out more about Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/).  For this sample, you can use the api key `special-key` to test the authorization filters.",
    "termsOfService": "http://swagger.io/terms/",
    "contact": {
      "email": "apiteam@swagger.io"
    },
    "license": {
      "name": "Apache 2.0",
      "url": "http://www.apache.org/licenses/LICENSE-2.0.html"
    },
    "version": "1.0.0"
  },
  "servers": [
    {
      "url": "http://petstore.swagger.io/v2"
    }
  ],
  "paths": {
    "/pets/findByStatus": {
      "get": {
        "tags": [
          "pets"
        ],
        "summary": "Finds Pets by status",
        "description": "Multiple status values can be provided with comma separated strings",
        "operationId": "findPetsByStatus",
        "parameters": [
          {
            "name": "status",
            "in": "query",
            "description": "Status values that need to be considered for filter",
            "required": true,
            "explode": true,
            "schema": {
              "type": "array",
              "items": {
                "type": "string",
                "enum": [
                  "available",
                  "pending",
                  "sold"
                ],
                "default": "available"
              }
            }
          }
        ],
        "responses": {
          "200": {
            "description": "successful operation",
            "content": {
              "application/xml": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/Pet"
                  }
                }
              },
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/Pet"
                  }
                }
              }
            }
          },
          "400": {
            "description": "Invalid status value"
          }
        },
        "security": [
          {
            "petstore_auth": [
              "write:pets",
              "read:pets"
            ]
          }
        ]
      }
    },
    "/pets/findByTags": {
      "get": {
        "tags": [
          "pets"
        ],
        "summary": "Finds Pets by tags",
        "description": "Muliple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.",
        "operationId": "findPetsByTags",
        "parameters": [
          {
            "name": "tags",
            "in": "query",
            "description": "Tags to filter by",
            "required": true,
            "explode": true,
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          }
        ],
        "responses": {
          "200": {
            "description": "successful operation",
            "content": {
              "application/xml": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/Pet"
                  }
                }
              },
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/Pet"
                  }
                }
              }
            }
          },
          "400": {
            "description": "Invalid tag value"
          }
        },
        "deprecated": true,
        "security": [
          {
            "petstore_auth": [
              "write:pets",
              "read:pets"
            ]
          }
        ]
      }
    },
    "/pets/{petId}": {
      "get": {
        "tags": [
          "pets"
        ],
        "summary": "Find pet by ID",
        "description": "Returns a single pet",
        "operationId": "getPetById",
        "parameters": [
          {
            "name": "petId",
            "in": "path",
            "description": "ID of pet to return",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "successful operation",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Pet"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/Pet"
                }
              }
            }
          },
          "400": {
            "description": "Invalid ID supplied"
          },
          "404": {
            "description": "Pet not found"
          }
        },
        "security": [
          {
            "api_key": []
          }
        ]
      },
      "post": {
        "tags": [
          "pets"
        ],
        "summary": "Updates a pet in the store with form data",
        "operationId": "updatePetWithForm",
        "parameters": [
          {
            "name": "petId",
            "in": "path",
            "description": "ID of pet that needs to be updated",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "name": {
                    "type": "string",
                    "description": "Updated name of the pet"
                  },
                  "status": {
                    "type": "string",
                    "description": "Updated status of the pet"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "405": {
            "description": "Invalid input"
          }
        },
        "security": [
          {
            "petstore_auth": [
              "write:pets",
              "read:pets"
            ]
          }
        ]
      },
      "delete": {
        "tags": [
          "pets"
        ],
        "summary": "Deletes a pet",
        "operationId": "deletePet",
        "parameters": [
          {
            "name": "api_key",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "petId",
            "in": "path",
            "description": "Pet id to delete",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          }
        ],
        "responses": {
          "400": {
            "description": "Invalid ID supplied"
          },
          "404": {
            "description": "Pet not found"
          }
        },
        "security": [
          {
            "petstore_auth": [
              "write:pets",
              "read:pets"
            ]
          }
        ]
      }
    },
    "/pets/{petId}/uploadImage": {
      "post": {
        "tags": [
          "pets"
        ],
        "summary": "uploads an image",
        "operationId": "uploadFile",
        "parameters": [
          {
            "name": "petId",
            "in": "path",
            "description": "ID of pet to update",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/octet-stream": {
              "schema": {
                "type": "string",
                "format": "binary"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "successful operation",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiResponse"
                }
              }
            }
          }
        },
        "security": [
          {
            "petstore_auth": [
              "write:pets",
              "read:pets"
            ]
          }
        ]
      }
    },
    "/stores/inventory": {
      "get": {
        "tags": [
          "stores"
        ],
        "summary": "Returns pet inventories by status",
        "description": "Returns a map of status codes to quantities",
        "operationId": "getInventory",
        "responses": {
          "200": {
            "description": "successful operation"
          }
        },
        "security": [
          {
            "api_key": []
          }
        ]
      }
    },
    "/stores/orders": {
      "post": {
        "tags": [
          "stores"
        ],
        "summary": "Place an order for a pet",
        "operationId": "placeOrder",
        "requestBody": {
          "description": "order placed for purchasing the pet",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Order"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "successful operation",
            "content": {
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/Order"
                }
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Order"
                }
              }
            }
          },
          "400": {
            "description": "Invalid Order"
          }
        }
      }
    },
    "/stores/orders/{orderId}": {
      "get": {
        "tags": [
          "stores"
        ],
        "summary": "Find purchase order by ID",
        "description": "For valid response try integer IDs with value >= 1 and <= 10. Other values will generated exceptions",
        "operationId": "getOrderById",
        "parameters": [
          {
            "name": "orderId",
            "in": "path",
            "description": "ID of pet that needs to be fetched",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int64",
              "minimum": 1,
              "maximum": 10
            }
          }
        ],
        "responses": {
          "200": {
            "description": "successful operation",
            "content": {
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/Order"
                }
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Order"
                }
              }
            }
          },
          "400": {
            "description": "Invalid ID supplied"
          },
          "404": {
            "description": "Order not found"
          }
        }
      },
      "delete": {
        "tags": [
          "stores"
        ],
        "summary": "Delete purchase order by ID",
        "description": "For valid response try integer IDs with positive integer value. Negative or non-integer values will generate API errors",
        "operationId": "deleteOrder",
        "parameters": [
          {
            "name": "orderId",
            "in": "path",
            "description": "ID of the order that needs to be deleted",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int64",
              "minimum": 1
            }
          }
        ],
        "responses": {
          "400": {
            "description": "Invalid ID supplied"
          },
          "404": {
            "description": "Order not found"
          }
        }
      }
    },
    "/users": {
      "post": {
        "tags": [
          "users"
        ],
        "summary": "Create user",
        "description": "This can only be done by the logged in user.",
        "operationId": "createUser",
        "requestBody": {
          "description": "Created user object",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/User"
              }
            }
          },
          "required": true
        },
        "responses": {
          "default": {
            "description": "successful operation"
          }
        }
      }
    },
    "/users/createWithArray": {
      "post": {
        "tags": [
          "users"
        ],
        "summary": "Creates list of users with given input array",
        "operationId": "createUsersWithArrayInput",
        "requestBody": {
          "$ref": "#/components/requestBodies/UserArray"
        },
        "responses": {
          "default": {
            "description": "successful operation"
          }
        }
      }
    },
    "/users/createWithList": {
      "post": {
        "tags": [
          "users"
        ],
        "summary": "Creates list of users with given input array",
        "operationId": "createUsersWithListInput",
        "requestBody": {
          "$ref": "#/components/requestBodies/UserArray"
        },
        "responses": {
          "default": {
            "description": "successful operation"
          }
        }
      }
    },
    "/users/login": {
      "get": {
        "tags": [
          "users"
        ],
        "summary": "Logs user into the system",
        "operationId": "loginUser",
        "parameters": [
          {
            "name": "username",
            "in": "query",
            "description": "The user name for login",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "password",
            "in": "query",
            "description": "The password for login in clear text",
            "required": true,
            "schema": {
              "type": "string",
              "format": "password"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "successful operation",
            "headers": {
              "X-Rate-Limit": {
                "description": "calls per hour allowed by the user",
                "schema": {
                  "type": "integer",
                  "format": "int32"
                }
              },
              "X-Expires-After": {
                "description": "date in UTC when token expires",
                "schema": {
                  "type": "string",
                  "format": "date-time"
                }
              }
            },
            "content": {
              "application/xml": {
                "schema": {
                  "type": "string"
                }
              },
              "application/json": {
                "schema": {
                  "type": "string"
                }
              }
            }
          },
          "400": {
            "description": "Invalid username/password supplied"
          }
        }
      }
    },
    "/users/logout": {
      "get": {
        "tags": [
          "users"
        ],
        "summary": "Logs out current logged in user session",
        "operationId": "logoutUser",
        "responses": {
          "default": {
            "description": "successful operation"
          }
        }
      }
    },
    "/users/{username}": {
      "get": {
        "tags": [
          "users"
        ],
        "summary": "Get user by user name",
        "operationId": "getUserByName",
        "parameters": [
          {
            "name": "username",
            "in": "path",
            "description": "The name that needs to be fetched. Use user1 for testing. ",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "successful operation",
            "content": {
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/User"
                }
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/User"
                }
              }
            }
          },
          "400": {
            "description": "Invalid username supplied"
          },
          "404": {
            "description": "User not found"
          }
        }
      },
      "put": {
        "tags": [
          "users"
        ],
        "summary": "Updated user",
        "description": "This can only be done by the logged in user.",
        "operationId": "updateUser",
        "parameters": [
          {
            "name": "username",
            "in": "path",
            "description": "name that need to be updated",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "description": "Updated user object",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/User"
              }
            }
          },
          "required": true
        },
        "responses": {
          "400": {
            "description": "Invalid user supplied"
          },
          "404": {
            "description": "User not found"
          }
        }
      },
      "delete": {
        "tags": [
          "users"
        ],
        "summary": "Delete user",
        "description": "This can only be done by the logged in user.",
        "operationId": "deleteUser",
        "parameters": [
          {
            "name": "username",
            "in": "path",
            "description": "The name that needs to be deleted",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "400": {
            "description": "Invalid username supplied"
          },
          "404": {
            "description": "User not found"
          }
        }
      }
    },
    "/pets/{petId}(1)": {
      "get": {
        "tags": [
          "pets"
        ],
        "summary": "Find pet by ID",
        "description": "Returns a single pet",
        "operationId": "getPetById",
        "parameters": [
          {
            "name": "petId",
            "in": "path",
            "description": "ID of pet to return",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "successful operation",
            "content": {
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/Pet"
                }
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Pet"
                }
              }
            }
          },
          "400": {
            "description": "Invalid ID supplied"
          },
          "404": {
            "description": "Pet not found"
          }
        },
        "security": [
          {
            "api_key": []
          }
        ]
      },
      "post": {
        "tags": [
          "pets"
        ],
        "summary": "Updates a pet in the store with form data",
        "operationId": "updatePetWithForm",
        "parameters": [
          {
            "name": "petId",
            "in": "path",
            "description": "ID of pet that needs to be updated",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/x-www-form-urlencoded": {
              "schema": {
                "type": "object",
                "properties": {
                  "name": {
                    "type": "string",
                    "description": "Updated name of the pet"
                  },
                  "status": {
                    "type": "string",
                    "description": "Updated status of the pet"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "405": {
            "description": "Invalid input"
          }
        },
        "security": [
          {
            "petstore_auth": [
              "write:pets",
              "read:pets"
            ]
          }
        ]
      },
      "delete": {
        "tags": [
          "pets"
        ],
        "summary": "Deletes a pet",
        "operationId": "deletePet",
        "parameters": [
          {
            "name": "api_key",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "petId",
            "in": "path",
            "description": "Pet id to delete",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          }
        ],
        "responses": {
          "400": {
            "description": "Invalid ID supplied"
          },
          "404": {
            "description": "Pet not found"
          }
        },
        "security": [
          {
            "petstore_auth": [
              "write:pets",
              "read:pets"
            ]
          }
        ]
      }
    }
  },
  "components": {
    "schemas": {
      "Order": {
        "type": "object",
        "title": "Order",
        "properties": {
          "id": {
            "type": "integer",
            "format": "int64",
            "title": "id"
          },
          "petId": {
            "type": "integer",
            "format": "int64",
            "title": "petId"
          },
          "quantity": {
            "type": "integer",
            "format": "int32",
            "title": "quantity"
          },
          "shipDate": {
            "type": "string",
            "format": "date-time",
            "title": "shipDate"
          },
          "status": {
            "type": "string",
            "title": "status",
            "description": "Order Status",
            "enum": [
              "placed",
              "approved",
              "delivered"
            ]
          },
          "complete": {
            "type": "boolean",
            "title": "complete",
            "default": false
          }
        },
        "xml": {}
      },
      "Category": {
        "type": "object",
        "title": "Category",
        "properties": {
          "id": {
            "type": "integer",
            "format": "int64",
            "title": "id"
          },
          "name": {
            "type": "string",
            "title": "name"
          }
        },
        "xml": {}
      },
      "User": {
        "type": "object",
        "title": "User",
        "properties": {
          "id": {
            "type": "integer",
            "format": "int64",
            "title": "id"
          },
          "username": {
            "type": "string",
            "title": "username"
          },
          "firstName": {
            "type": "string",
            "title": "firstName"
          },
          "lastName": {
            "type": "string",
            "title": "lastName"
          },
          "email": {
            "type": "string",
            "title": "email"
          },
          "password": {
            "type": "string",
            "title": "password"
          },
          "phone": {
            "type": "string",
            "title": "phone"
          },
          "userStatus": {
            "type": "integer",
            "format": "int32",
            "title": "userStatus",
            "description": "User Status"
          }
        },
        "xml": {}
      },
      "Tag": {
        "type": "object",
        "title": "Tag",
        "properties": {
          "id": {
            "type": "integer",
            "format": "int64",
            "title": "id"
          },
          "name": {
            "type": "string",
            "title": "name"
          }
        },
        "xml": {}
      },
      "Pet": {
        "type": "object",
        "title": "Pet",
        "required": [
          "name",
          "photoUrls"
        ],
        "properties": {
          "id": {
            "type": "integer",
            "format": "int64",
            "title": "id"
          },
          "category": {
            "$ref": "#/components/schemas/Category"
          },
          "name": {
            "type": "string",
            "title": "name"
          },
          "photoUrls": {
            "type": "array",
            "title": "photoUrls",
            "items": {
              "type": "string"
            },
            "xml": {}
          },
          "tags": {
            "type": "array",
            "title": "tags",
            "items": {
              "$ref": "#/components/schemas/Tag"
            },
            "xml": {}
          },
          "status": {
            "type": "string",
            "title": "status",
            "description": "pet status in the store",
            "enum": [
              "available",
              "pending",
              "sold"
            ]
          }
        },
        "xml": {}
      },
      "ApiResponse": {
        "type": "object",
        "title": "ApiResponse",
        "properties": {
          "code": {
            "type": "integer",
            "format": "int32",
            "title": "code"
          },
          "type": {
            "type": "string",
            "title": "type"
          },
          "message": {
            "type": "string",
            "title": "message"
          }
        }
      }
    },
    "requestBodies": {
      "Pet": {
        "description": "Pet object that needs to be added to the store",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/Pet"
            }
          },
          "application/xml": {
            "schema": {
              "$ref": "#/components/schemas/Pet"
            }
          }
        },
        "required": true
      },
      "UserArray": {
        "description": "List of user object",
        "content": {
          "application/json": {
            "schema": {
              "type": "array",
              "title": "schema",
              "items": {
                "$ref": "#/components/schemas/User"
              }
            }
          }
        },
        "required": true
      }
    },
    "securitySchemes": {
      "petstore_auth": {
        "flows": {
          "implicit": {
            "authorizationUrl": "http://petstore.swagger.io/oauth/dialog",
            "scopes": {
              "write:pets": "modify pets in your account",
              "read:pets": "read your pets"
            }
          }
        },
        "type": "oauth2"
      },
      "api_key": {
        "name": "api_key",
        "in": "header",
        "type": "apiKey"
      }
    },
    "callbacks": {
      "myEvent": {
        "{$request.body#/callbackUrl}'": {
          "post": {
            "tags": [
              "pets"
            ],
            "summary": "Add a new pet to the store",
            "operationId": "addPet",
            "requestBody": {
              "$ref": "#model/definitions/requestBodies/Pet"
            },
            "responses": {
              "405": {
                "description": "Invalid input"
              }
            },
            "security": [
              {
                "petstore_auth": [
                  "write:pets",
                  "read:pets"
                ]
              }
            ]
          },
          "put": {
            "tags": [
              "pets"
            ],
            "summary": "Update an existing pet",
            "operationId": "updatePet",
            "requestBody": {
              "$ref": "#model/definitions/requestBodies/Pet"
            },
            "responses": {
              "400": {
                "description": "Invalid ID supplied"
              },
              "404": {
                "description": "Pet not found"
              },
              "405": {
                "description": "Validation exception"
              }
            },
            "security": [
              {
                "petstore_auth": [
                  "write:pets",
                  "read:pets"
                ]
              }
            ]
          }
        }
      }
    }
  },
  "tags": [
    {
      "name": "pets",
      "description": "Everything about your Pets"
    },
    {
      "name": "stores",
      "description": "Find out more"
    },
    {
      "name": "users",
      "description": "More about users"
    }
  ],
  "externalDocs": {
    "description": "Find out more about Swagger",
    "url": "http://swagger.io"
  },
  "x-origin": {
    "url": "http://petstore.swagger.io/v2/swagger.json",
    "format": "swagger",
    "version": "2.0",
    "converter": {
      "url": "https://github.com/mermade/swagger2openapi",
      "version": "2.2.0"
    }
  }
}
2. Resources
2.1 Resource /pets
2.1.1 /pets Properties
PropertyValue
Resource path/pets
Activatedtrue
Description
summary
extensions
[1] pattern
value
Comments
2.1.2 /pets Requests
2.1.2.1 Request post
2.1.2.1.1 post Tree Diagram
2.1.2.1.2 post Properties
PropertyValue
Request operationpost
Activatedtrue
Id
$ref
Description
Resources/pets
Parent request
Child response
Comments
tags
[1] tagpets
summaryAdd a new pet to the store
externalDocs
[1] url
description
extensions
operationIdaddPet
deprecated
security
[1] pattern {name}petstore_auth
operationwrite:petsread:pets
servers
[1] url
description
variables
extensions
extensions
[1] pattern
value
2.1.2.1.3 post Fields
FieldTypeReqKeyDescriptionComments
parametersarrayfalse
requestBodyrequestBodyfalse

Pet object that needs to be added to the store

application/jsonmediafalse
schemaobjectfalse
idint64false
categorystringfalse
namestringtrue
photoUrlsarraytrue
[0]stringfalse
tagsarrayfalse
[0]stringfalse
statusstringfalse

pet status in the store

examplesobjectfalse
encodingobjectfalse
application/xmlmediafalse
schemaobjectfalse
idint64false
categorystringfalse
namestringtrue
photoUrlsarraytrue
[0]stringfalse
tagsarrayfalse
[0]stringfalse
statusstringfalse

pet status in the store

examplesobjectfalse
encodingobjectfalse
callbacksoperationObjectfalse
2.1.2.1.3.1 Field parameters
2.1.2.1.3.1.1 parameters properties
PropertyValue
Name parameters
Technical name parameters
Id
Type array
Title
Description
Required
Min items
Max items
Unique items
Additional items true
Comments
2.1.2.1.3.2 Field requestBody
2.1.2.1.3.2.1 requestBody properties
PropertyValue
Name requestBody
Technical name
Activated true
Reference type model
Reference description
2.1.2.1.3.3 Field callbacks
2.1.2.1.3.3.1 callbacks properties
PropertyValue
Name callbacks
Technical name
Type operationObject
2.1.2.1.4 post JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "post",
    "properties": {
        "parameters": {
            "type": "array",
            "title": "parameters",
            "additionalItems": true
        },
        "requestBody": {
            "$ref": "#model/definitions/requestBodies/properties/Pet"
        },
        "callbacks": {
            "type": "object",
            "additionalProperties": false
        }
    },
    "additionalProperties": true
}
2.1.2.1.5 post JSON data
{
    "parameters": [],
    "requestBody": {
        "application/json": {
            "schema": {
                "id": -26,
                "category": "Lorem",
                "name": "Lorem",
                "photoUrls": [
                    "Lorem"
                ],
                "tags": [
                    "Lorem"
                ],
                "status": "sold"
            },
            "examples": {},
            "encoding": {}
        },
        "application/xml": {
            "schema": {
                "id": -60,
                "category": "Lorem",
                "name": "Lorem",
                "photoUrls": [
                    "Lorem"
                ],
                "tags": [
                    "Lorem"
                ],
                "status": "sold"
            },
            "examples": {},
            "encoding": {}
        }
    },
    "callbacks": {}
}
2.1.2.1.6 post Responses:
2.1.2.1.6.1 Response 405
2.1.2.1.6.1.1 405 Tree Diagram
2.1.2.1.6.1.2 405 Properties
PropertyValue
Response405
Activatedtrue
Id
$ref
Description

Invalid input

Resources/pets
Parent requestpost
Child response
Comments
extensions
[1] pattern
value
2.1.2.1.6.1.3 405 Fields
FieldTypeReqKeyDescriptionComments
responseresponsefalse

Invalid input

headersobjectfalse
contentobjectfalse
linksobjectfalse
2.1.2.1.6.1.3.1 Field response
2.1.2.1.6.1.3.1.1 response Hierarchy
Parent field: 405
Child field(s):
FieldTypeReqKeyDescriptionComments
headersobjectfalse
contentobjectfalse
linksobjectfalse
2.1.2.1.6.1.3.1.2 response properties
PropertyValue
Type response
Comments
Description

Invalid input

extensions
2.1.2.1.6.1.3.2 Field headers
2.1.2.1.6.1.3.2.1 headers properties
PropertyValue
Name headers
Technical name headers
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.1.2.1.6.1.3.3 Field content
2.1.2.1.6.1.3.3.1 content properties
PropertyValue
Name content
Technical name content
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.1.2.1.6.1.3.4 Field links
2.1.2.1.6.1.3.4.1 links properties
PropertyValue
Name links
Technical name links
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.1.2.1.6.1.4 405 JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "405",
    "description": "Invalid input",
    "properties": {
        "response": {
            "type": "object",
            "description": "Invalid input",
            "properties": {
                "headers": {
                    "type": "object",
                    "title": "headers",
                    "additionalProperties": false
                },
                "content": {
                    "type": "object",
                    "title": "content",
                    "additionalProperties": false
                },
                "links": {
                    "type": "object",
                    "title": "links",
                    "additionalProperties": false
                }
            },
            "additionalProperties": false
        }
    },
    "additionalProperties": true
}
2.1.2.1.6.1.5 405 JSON data
{
    "response": {
        "headers": {},
        "content": {},
        "links": {}
    }
}
2.1.2.2 Request put
2.1.2.2.1 put Tree Diagram
2.1.2.2.2 put Properties
PropertyValue
Request operationput
Activatedtrue
Id
$ref
Description
Resources/pets
Parent request
Child response
Comments
tags
[1] tagpets
summaryUpdate an existing pet
externalDocs
[1] url
description
extensions
operationIdupdatePet
deprecated
security
[1] pattern {name}petstore_auth
operationwrite:petsread:pets
servers
[1] url
description
variables
extensions
extensions
[1] pattern
value
2.1.2.2.3 put Fields
FieldTypeReqKeyDescriptionComments
parametersarrayfalse
requestBodyrequestBodyfalse

Pet object that needs to be added to the store

application/jsonmediafalse
schemaobjectfalse
idint64false
categorystringfalse
namestringtrue
photoUrlsarraytrue
[0]stringfalse
tagsarrayfalse
[0]stringfalse
statusstringfalse

pet status in the store

examplesobjectfalse
encodingobjectfalse
application/xmlmediafalse
schemaobjectfalse
idint64false
categorystringfalse
namestringtrue
photoUrlsarraytrue
[0]stringfalse
tagsarrayfalse
[0]stringfalse
statusstringfalse

pet status in the store

examplesobjectfalse
encodingobjectfalse
callbacksoperationObjectfalse
2.1.2.2.3.1 Field parameters
2.1.2.2.3.1.1 parameters properties
PropertyValue
Name parameters
Technical name parameters
Id
Type array
Title
Description
Required
Min items
Max items
Unique items
Additional items true
Comments
2.1.2.2.3.2 Field requestBody
2.1.2.2.3.2.1 requestBody properties
PropertyValue
Name requestBody
Technical name
Activated true
Reference type model
Reference description
2.1.2.2.3.3 Field callbacks
2.1.2.2.3.3.1 callbacks properties
PropertyValue
Name callbacks
Technical name
Type operationObject
2.1.2.2.4 put JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "put",
    "properties": {
        "parameters": {
            "type": "array",
            "title": "parameters",
            "additionalItems": true
        },
        "requestBody": {
            "$ref": "#model/definitions/requestBodies/properties/Pet"
        },
        "callbacks": {
            "type": "object",
            "additionalProperties": false
        }
    },
    "additionalProperties": true
}
2.1.2.2.5 put JSON data
{
    "parameters": [],
    "requestBody": {
        "application/json": {
            "schema": {
                "id": -53,
                "category": "Lorem",
                "name": "Lorem",
                "photoUrls": [
                    "Lorem"
                ],
                "tags": [
                    "Lorem"
                ],
                "status": "sold"
            },
            "examples": {},
            "encoding": {}
        },
        "application/xml": {
            "schema": {
                "id": 8,
                "category": "Lorem",
                "name": "Lorem",
                "photoUrls": [
                    "Lorem"
                ],
                "tags": [
                    "Lorem"
                ],
                "status": "sold"
            },
            "examples": {},
            "encoding": {}
        }
    },
    "callbacks": {}
}
2.1.2.2.6 put Responses:
2.1.2.2.6.1 Response 400
2.1.2.2.6.1.1 400 Tree Diagram
2.1.2.2.6.1.2 400 Properties
PropertyValue
Response400
Activatedtrue
Id
$ref
Description

Invalid ID supplied

Resources/pets
Parent requestput
Child response
Comments
extensions
[1] pattern
value
2.1.2.2.6.1.3 400 Fields
FieldTypeReqKeyDescriptionComments
responseresponsefalse

Invalid ID supplied

headersobjectfalse
contentobjectfalse
linksobjectfalse
2.1.2.2.6.1.3.1 Field response
2.1.2.2.6.1.3.1.1 response Hierarchy
Parent field: 400
Child field(s):
FieldTypeReqKeyDescriptionComments
headersobjectfalse
contentobjectfalse
linksobjectfalse
2.1.2.2.6.1.3.1.2 response properties
PropertyValue
Type response
Comments
Description

Invalid ID supplied

extensions
2.1.2.2.6.1.3.2 Field headers
2.1.2.2.6.1.3.2.1 headers properties
PropertyValue
Name headers
Technical name headers
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.1.2.2.6.1.3.3 Field content
2.1.2.2.6.1.3.3.1 content properties
PropertyValue
Name content
Technical name content
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.1.2.2.6.1.3.4 Field links
2.1.2.2.6.1.3.4.1 links properties
PropertyValue
Name links
Technical name links
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.1.2.2.6.1.4 400 JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "400",
    "description": "Invalid ID supplied",
    "properties": {
        "response": {
            "type": "object",
            "description": "Invalid ID supplied",
            "properties": {
                "headers": {
                    "type": "object",
                    "title": "headers",
                    "additionalProperties": false
                },
                "content": {
                    "type": "object",
                    "title": "content",
                    "additionalProperties": false
                },
                "links": {
                    "type": "object",
                    "title": "links",
                    "additionalProperties": false
                }
            },
            "additionalProperties": false
        }
    },
    "additionalProperties": true
}
2.1.2.2.6.1.5 400 JSON data
{
    "response": {
        "headers": {},
        "content": {},
        "links": {}
    }
}
2.1.2.2.6.2 Response 404
2.1.2.2.6.2.1 404 Tree Diagram
2.1.2.2.6.2.2 404 Properties
PropertyValue
Response404
Activatedtrue
Id
$ref
Description

Pet not found

Resources/pets
Parent requestput
Child response
Comments
extensions
[1] pattern
value
2.1.2.2.6.2.3 404 Fields
FieldTypeReqKeyDescriptionComments
responseresponsefalse

Pet not found

headersobjectfalse
contentobjectfalse
linksobjectfalse
2.1.2.2.6.2.3.1 Field response
2.1.2.2.6.2.3.1.1 response Hierarchy
Parent field: 404
Child field(s):
FieldTypeReqKeyDescriptionComments
headersobjectfalse
contentobjectfalse
linksobjectfalse
2.1.2.2.6.2.3.1.2 response properties
PropertyValue
Type response
Comments
Description

Pet not found

extensions
2.1.2.2.6.2.3.2 Field headers
2.1.2.2.6.2.3.2.1 headers properties
PropertyValue
Name headers
Technical name headers
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.1.2.2.6.2.3.3 Field content
2.1.2.2.6.2.3.3.1 content properties
PropertyValue
Name content
Technical name content
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.1.2.2.6.2.3.4 Field links
2.1.2.2.6.2.3.4.1 links properties
PropertyValue
Name links
Technical name links
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.1.2.2.6.2.4 404 JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "404",
    "description": "Pet not found",
    "properties": {
        "response": {
            "type": "object",
            "description": "Pet not found",
            "properties": {
                "headers": {
                    "type": "object",
                    "title": "headers",
                    "additionalProperties": false
                },
                "content": {
                    "type": "object",
                    "title": "content",
                    "additionalProperties": false
                },
                "links": {
                    "type": "object",
                    "title": "links",
                    "additionalProperties": false
                }
            },
            "additionalProperties": false
        }
    },
    "additionalProperties": true
}
2.1.2.2.6.2.5 404 JSON data
{
    "response": {
        "headers": {},
        "content": {},
        "links": {}
    }
}
2.1.2.2.6.3 Response 405
2.1.2.2.6.3.1 405 Tree Diagram
2.1.2.2.6.3.2 405 Properties
PropertyValue
Response405
Activatedtrue
Id
$ref
Description

Validation exception

Resources/pets
Parent requestput
Child response
Comments
extensions
[1] pattern
value
2.1.2.2.6.3.3 405 Fields
FieldTypeReqKeyDescriptionComments
responseresponsefalse

Validation exception

headersobjectfalse
contentobjectfalse
linksobjectfalse
2.1.2.2.6.3.3.1 Field response
2.1.2.2.6.3.3.1.1 response Hierarchy
Parent field: 405
Child field(s):
FieldTypeReqKeyDescriptionComments
headersobjectfalse
contentobjectfalse
linksobjectfalse
2.1.2.2.6.3.3.1.2 response properties
PropertyValue
Type response
Comments
Description

Validation exception

extensions
2.1.2.2.6.3.3.2 Field headers
2.1.2.2.6.3.3.2.1 headers properties
PropertyValue
Name headers
Technical name headers
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.1.2.2.6.3.3.3 Field content
2.1.2.2.6.3.3.3.1 content properties
PropertyValue
Name content
Technical name content
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.1.2.2.6.3.3.4 Field links
2.1.2.2.6.3.3.4.1 links properties
PropertyValue
Name links
Technical name links
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.1.2.2.6.3.4 405 JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "405",
    "description": "Validation exception",
    "properties": {
        "response": {
            "type": "object",
            "description": "Validation exception",
            "properties": {
                "headers": {
                    "type": "object",
                    "title": "headers",
                    "additionalProperties": false
                },
                "content": {
                    "type": "object",
                    "title": "content",
                    "additionalProperties": false
                },
                "links": {
                    "type": "object",
                    "title": "links",
                    "additionalProperties": false
                }
            },
            "additionalProperties": false
        }
    },
    "additionalProperties": true
}
2.1.2.2.6.3.5 405 JSON data
{
    "response": {
        "headers": {},
        "content": {},
        "links": {}
    }
}
2.2 Resource /pets/findByStatus
2.2.1 /pets/findByStatus Properties
PropertyValue
Resource path/pets/findByStatus
Activatedtrue
Description
summary
extensions
[1] pattern
value
Comments
2.2.2 /pets/findByStatus Requests
2.2.2.1 Request get
2.2.2.1.1 get Tree Diagram
2.2.2.1.2 get Properties
PropertyValue
Request operationget
Activatedtrue
Id
$ref
Description

Multiple status values can be provided with comma separated strings

Resources/pets/findByStatus
Parent request
Child response
Comments
tags
[1] tagpets
summaryFinds Pets by status
externalDocs
[1] url
description
extensions
operationIdfindPetsByStatus
deprecated
security
[1] pattern {name}petstore_auth
operationwrite:petsread:pets
servers
[1] url
description
variables
extensions
extensions
[1] pattern
value
2.2.2.1.3 get Fields
FieldTypeReqKeyDescriptionComments
parametersarrayfalse
[0] statusparameter (query)true

Status values that need to be considered for filter

schemaarrayfalse
[0]stringfalse
contentobjectfalse
examplesobjectfalse
requestBodyrequestBodyfalse
callbacksoperationObjectfalse
2.2.2.1.3.1 Field parameters
2.2.2.1.3.1.1 parameters Hierarchy
Parent field: get
Child field(s):
FieldTypeReqKeyDescriptionComments
[0] statusparameter (query)true

Status values that need to be considered for filter

2.2.2.1.3.1.2 parameters properties
PropertyValue
Name parameters
Technical name parameters
Id
Type array
Title
Description
Required
Min items
Max items
Unique items
Additional items true
Comments
2.2.2.1.3.2 Field [0] status
2.2.2.1.3.2.1 [0] status Hierarchy
Parent field: parameters
Child field(s):
FieldTypeReqKeyDescriptionComments
schemaarrayfalse
contentobjectfalse
examplesobjectfalse
2.2.2.1.3.2.2 [0] status properties
PropertyValue
Display name status
Activated true
Parameter name status
Type parameter (query)
Description

Status values that need to be considered for filter

Comments
Required true
Deprecated
Allow empty value
Style
Explode true
Allow Reserved
example
extensions
2.2.2.1.3.3 Field schema
2.2.2.1.3.3.1 schema Hierarchy
Parent field: [0] status
Child field(s):
FieldTypeReqKeyDescriptionComments
[0]stringfalse
2.2.2.1.3.3.2 schema properties
PropertyValue
Name schema
Technical name
Activated true
Id
Type array
Title
Description
Required
Min items
Max items
Unique items
Additional items true
nullable
readOnly
writeOnly
xml
externalDocs
collectionFormat
example (deprecated)
Comments
2.2.2.1.3.4 Field [0]
2.2.2.1.3.4.1 [0] properties
PropertyValue
Display name
Activated true
Id
Type string
Format
Title
Description
Deprecated
Default available
Min length
Max length
Pattern
Enum available,pending,sold
Faker function
example (deprecated)
nullable
readOnly
writeOnly
xml
externalDocs
Comments
2.2.2.1.3.5 Field content
2.2.2.1.3.5.1 content properties
PropertyValue
Name content
Technical name content
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.2.2.1.3.6 Field examples
2.2.2.1.3.6.1 examples properties
PropertyValue
Name examples
Technical name examples
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.2.2.1.3.7 Field requestBody
2.2.2.1.3.7.1 requestBody properties
PropertyValue
Name requestBody
Technical name
Comments
Type requestBody
Required
Description
extensions
2.2.2.1.3.8 Field callbacks
2.2.2.1.3.8.1 callbacks properties
PropertyValue
Name callbacks
Technical name
Type operationObject
2.2.2.1.4 get JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "get",
    "description": "Multiple status values can be provided with comma separated strings",
    "properties": {
        "parameters": {
            "type": "array",
            "title": "parameters",
            "additionalItems": true,
            "items": {
                "type": "object",
                "description": "Status values that need to be considered for filter",
                "properties": {
                    "schema": {
                        "type": "array",
                        "additionalItems": true,
                        "items": {
                            "type": "string",
                            "default": "available",
                            "enum": [
                                "available",
                                "pending",
                                "sold"
                            ]
                        }
                    },
                    "content": {
                        "type": "object",
                        "title": "content",
                        "additionalProperties": false
                    },
                    "examples": {
                        "type": "object",
                        "title": "examples",
                        "additionalProperties": false
                    }
                },
                "additionalProperties": false
            }
        },
        "requestBody": {
            "type": "object",
            "additionalProperties": false
        },
        "callbacks": {
            "type": "object",
            "additionalProperties": false
        }
    },
    "additionalProperties": true
}
2.2.2.1.5 get JSON data
{
    "parameters": [
        {
            "schema": [
                "available"
            ],
            "content": {},
            "examples": {}
        }
    ],
    "requestBody": {},
    "callbacks": {}
}
2.2.2.1.6 get Responses:
2.2.2.1.6.1 Response 200
2.2.2.1.6.1.1 200 Tree Diagram
2.2.2.1.6.1.2 200 Properties
PropertyValue
Response200
Activatedtrue
Id
$ref
Description

successful operation

Resources/pets/findByStatus
Parent requestget
Child response
Comments
extensions
[1] pattern
value
2.2.2.1.6.1.3 200 Fields
FieldTypeReqKeyDescriptionComments
responseresponsefalse

successful operation

headersobjectfalse
contentobjectfalse
application/xmlmediafalse
schemaarrayfalse
[0]objectfalse
idint64false
categorystringfalse
namestringtrue
photoUrlsarraytrue
[0]stringfalse
tagsarrayfalse
[0]stringfalse
statusstringfalse

pet status in the store

examplesobjectfalse
encodingobjectfalse
application/jsonmediafalse
schemaarrayfalse
[0]objectfalse
idint64false
categorystringfalse
namestringtrue
photoUrlsarraytrue
[0]stringfalse
tagsarrayfalse
[0]stringfalse
statusstringfalse

pet status in the store

examplesobjectfalse
encodingobjectfalse
linksobjectfalse
2.2.2.1.6.1.3.1 Field response
2.2.2.1.6.1.3.1.1 response Hierarchy
Parent field: 200
Child field(s):
FieldTypeReqKeyDescriptionComments
headersobjectfalse
contentobjectfalse
linksobjectfalse
2.2.2.1.6.1.3.1.2 response properties
PropertyValue
Type response
Comments
Description

successful operation

extensions
2.2.2.1.6.1.3.2 Field headers
2.2.2.1.6.1.3.2.1 headers properties
PropertyValue
Name headers
Technical name headers
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.2.2.1.6.1.3.3 Field content
2.2.2.1.6.1.3.3.1 content Hierarchy
Parent field: response
Child field(s):
FieldTypeReqKeyDescriptionComments
application/xmlmediafalse
application/jsonmediafalse
2.2.2.1.6.1.3.3.2 content properties
PropertyValue
Name content
Technical name content
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.2.2.1.6.1.3.4 Field application/xml
2.2.2.1.6.1.3.4.1 application/xml Hierarchy
Parent field: content
Child field(s):
FieldTypeReqKeyDescriptionComments
schemaarrayfalse
examplesobjectfalse
encodingobjectfalse
2.2.2.1.6.1.3.4.2 application/xml properties
PropertyValue
Name application/xml
Activated true
Description
Comments
example
Type media
extensions
2.2.2.1.6.1.3.5 Field schema
2.2.2.1.6.1.3.5.1 schema Hierarchy
Parent field: application/xml
Child field(s):
FieldTypeReqKeyDescriptionComments
[0]referencefalse
2.2.2.1.6.1.3.5.2 schema properties
PropertyValue
Name schema
Technical name
Activated true
Id
Type array
Title
Description
Required
Min items
Max items
Unique items
Additional items true
nullable
readOnly
writeOnly
xml
externalDocs
collectionFormat
example (deprecated)
Comments
2.2.2.1.6.1.3.6 Field [0]
2.2.2.1.6.1.3.6.1 [0] properties
PropertyValue
Name
Activated true
Reference type model
Reference description
2.2.2.1.6.1.3.7 Field examples
2.2.2.1.6.1.3.7.1 examples properties
PropertyValue
Name examples
Technical name examples
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.2.2.1.6.1.3.8 Field encoding
2.2.2.1.6.1.3.8.1 encoding properties
PropertyValue
Name encoding
Technical name encoding
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.2.2.1.6.1.3.9 Field application/json
2.2.2.1.6.1.3.9.1 application/json Hierarchy
Parent field: content
Child field(s):
FieldTypeReqKeyDescriptionComments
schemaarrayfalse
examplesobjectfalse
encodingobjectfalse
2.2.2.1.6.1.3.9.2 application/json properties
PropertyValue
Name application/json
Activated true
Description
Comments
example
Type media
extensions
2.2.2.1.6.1.3.10 Field schema
2.2.2.1.6.1.3.10.1 schema Hierarchy
Parent field: application/json
Child field(s):
FieldTypeReqKeyDescriptionComments
[0]referencefalse
2.2.2.1.6.1.3.10.2 schema properties
PropertyValue
Name schema
Technical name
Activated true
Id
Type array
Title
Description
Required
Min items
Max items
Unique items
Additional items true
nullable
readOnly
writeOnly
xml
externalDocs
collectionFormat
example (deprecated)
Comments
2.2.2.1.6.1.3.11 Field [0]
2.2.2.1.6.1.3.11.1 [0] properties
PropertyValue
Name
Activated true
Reference type model
Reference description
2.2.2.1.6.1.3.12 Field examples
2.2.2.1.6.1.3.12.1 examples properties
PropertyValue
Name examples
Technical name examples
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.2.2.1.6.1.3.13 Field encoding
2.2.2.1.6.1.3.13.1 encoding properties
PropertyValue
Name encoding
Technical name encoding
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.2.2.1.6.1.3.14 Field links
2.2.2.1.6.1.3.14.1 links properties
PropertyValue
Name links
Technical name links
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.2.2.1.6.1.4 200 JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "200",
    "description": "successful operation",
    "properties": {
        "response": {
            "type": "object",
            "description": "successful operation",
            "properties": {
                "headers": {
                    "type": "object",
                    "title": "headers",
                    "additionalProperties": false
                },
                "content": {
                    "type": "object",
                    "title": "content",
                    "properties": {
                        "application/xml": {
                            "type": "object",
                            "properties": {
                                "schema": {
                                    "type": "array",
                                    "additionalItems": true,
                                    "items": {
                                        "$ref": "#model/definitions/schemas/properties/Pet"
                                    }
                                },
                                "examples": {
                                    "type": "object",
                                    "title": "examples",
                                    "additionalProperties": false
                                },
                                "encoding": {
                                    "type": "object",
                                    "title": "encoding",
                                    "additionalProperties": false
                                }
                            },
                            "additionalProperties": false
                        },
                        "application/json": {
                            "type": "object",
                            "properties": {
                                "schema": {
                                    "type": "array",
                                    "additionalItems": true,
                                    "items": {
                                        "$ref": "#model/definitions/schemas/properties/Pet"
                                    }
                                },
                                "examples": {
                                    "type": "object",
                                    "title": "examples",
                                    "additionalProperties": false
                                },
                                "encoding": {
                                    "type": "object",
                                    "title": "encoding",
                                    "additionalProperties": false
                                }
                            },
                            "additionalProperties": false
                        }
                    },
                    "additionalProperties": false
                },
                "links": {
                    "type": "object",
                    "title": "links",
                    "additionalProperties": false
                }
            },
            "additionalProperties": false
        }
    },
    "additionalProperties": true
}
2.2.2.1.6.1.5 200 JSON data
{
    "response": {
        "headers": {},
        "content": {
            "application/xml": {
                "schema": [
                    {
                        "id": 76,
                        "category": "Lorem",
                        "name": "Lorem",
                        "photoUrls": [
                            "Lorem"
                        ],
                        "tags": [
                            "Lorem"
                        ],
                        "status": "sold"
                    }
                ],
                "examples": {},
                "encoding": {}
            },
            "application/json": {
                "schema": [
                    {
                        "id": 49,
                        "category": "Lorem",
                        "name": "Lorem",
                        "photoUrls": [
                            "Lorem"
                        ],
                        "tags": [
                            "Lorem"
                        ],
                        "status": "sold"
                    }
                ],
                "examples": {},
                "encoding": {}
            }
        },
        "links": {}
    }
}
2.2.2.1.6.2 Response 400
2.2.2.1.6.2.1 400 Tree Diagram
2.2.2.1.6.2.2 400 Properties
PropertyValue
Response400
Activatedtrue
Id
$ref
Description

Invalid status value

Resources/pets/findByStatus
Parent requestget
Child response
Comments
extensions
[1] pattern
value
2.2.2.1.6.2.3 400 Fields
FieldTypeReqKeyDescriptionComments
responseresponsefalse

Invalid status value

headersobjectfalse
contentobjectfalse
linksobjectfalse
2.2.2.1.6.2.3.1 Field response
2.2.2.1.6.2.3.1.1 response Hierarchy
Parent field: 400
Child field(s):
FieldTypeReqKeyDescriptionComments
headersobjectfalse
contentobjectfalse
linksobjectfalse
2.2.2.1.6.2.3.1.2 response properties
PropertyValue
Type response
Comments
Description

Invalid status value

extensions
2.2.2.1.6.2.3.2 Field headers
2.2.2.1.6.2.3.2.1 headers properties
PropertyValue
Name headers
Technical name headers
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.2.2.1.6.2.3.3 Field content
2.2.2.1.6.2.3.3.1 content properties
PropertyValue
Name content
Technical name content
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.2.2.1.6.2.3.4 Field links
2.2.2.1.6.2.3.4.1 links properties
PropertyValue
Name links
Technical name links
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.2.2.1.6.2.4 400 JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "400",
    "description": "Invalid status value",
    "properties": {
        "response": {
            "type": "object",
            "description": "Invalid status value",
            "properties": {
                "headers": {
                    "type": "object",
                    "title": "headers",
                    "additionalProperties": false
                },
                "content": {
                    "type": "object",
                    "title": "content",
                    "additionalProperties": false
                },
                "links": {
                    "type": "object",
                    "title": "links",
                    "additionalProperties": false
                }
            },
            "additionalProperties": false
        }
    },
    "additionalProperties": true
}
2.2.2.1.6.2.5 400 JSON data
{
    "response": {
        "headers": {},
        "content": {},
        "links": {}
    }
}
2.3 Resource /pets/findByTags
2.3.1 /pets/findByTags Properties
PropertyValue
Resource path/pets/findByTags
Activatedtrue
Description
summary
extensions
[1] pattern
value
Comments
2.3.2 /pets/findByTags Requests
2.3.2.1 Request get
2.3.2.1.1 get Tree Diagram
2.3.2.1.2 get Properties
PropertyValue
Request operationget
Activatedtrue
Id
$ref
Description

Muliple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.

Resources/pets/findByTags
Parent request
Child response
Comments
tags
[1] tagpets
summaryFinds Pets by tags
externalDocs
[1] url
description
extensions
operationIdfindPetsByTags
deprecatedtrue
security
[1] pattern {name}petstore_auth
operationwrite:petsread:pets
servers
[1] url
description
variables
extensions
extensions
[1] pattern
value
2.3.2.1.3 get Fields
FieldTypeReqKeyDescriptionComments
parametersarrayfalse
[0] tagsparameter (query)true

Tags to filter by

schemaarrayfalse
[0]stringfalse
contentobjectfalse
examplesobjectfalse
requestBodyrequestBodyfalse
callbacksoperationObjectfalse
2.3.2.1.3.1 Field parameters
2.3.2.1.3.1.1 parameters Hierarchy
Parent field: get
Child field(s):
FieldTypeReqKeyDescriptionComments
[0] tagsparameter (query)true

Tags to filter by

2.3.2.1.3.1.2 parameters properties
PropertyValue
Name parameters
Technical name parameters
Id
Type array
Title
Description
Required
Min items
Max items
Unique items
Additional items true
Comments
2.3.2.1.3.2 Field [0] tags
2.3.2.1.3.2.1 [0] tags Hierarchy
Parent field: parameters
Child field(s):
FieldTypeReqKeyDescriptionComments
schemaarrayfalse
contentobjectfalse
examplesobjectfalse
2.3.2.1.3.2.2 [0] tags properties
PropertyValue
Display name tags
Activated true
Parameter name tags
Type parameter (query)
Description

Tags to filter by

Comments
Required true
Deprecated
Allow empty value
Style
Explode true
Allow Reserved
example
extensions
2.3.2.1.3.3 Field schema
2.3.2.1.3.3.1 schema Hierarchy
Parent field: [0] tags
Child field(s):
FieldTypeReqKeyDescriptionComments
[0]stringfalse
2.3.2.1.3.3.2 schema properties
PropertyValue
Name schema
Technical name
Activated true
Id
Type array
Title
Description
Required
Min items
Max items
Unique items
Additional items true
nullable
readOnly
writeOnly
xml
externalDocs
collectionFormat
example (deprecated)
Comments
2.3.2.1.3.4 Field [0]
2.3.2.1.3.4.1 [0] properties
PropertyValue
Display name
Activated true
Id
Type string
Format
Title
Description
Deprecated
Default
Min length
Max length
Pattern
Enum
Faker function
example (deprecated)
nullable
readOnly
writeOnly
xml
externalDocs
Comments
2.3.2.1.3.5 Field content
2.3.2.1.3.5.1 content properties
PropertyValue
Name content
Technical name content
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.3.2.1.3.6 Field examples
2.3.2.1.3.6.1 examples properties
PropertyValue
Name examples
Technical name examples
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.3.2.1.3.7 Field requestBody
2.3.2.1.3.7.1 requestBody properties
PropertyValue
Name requestBody
Technical name
Comments
Type requestBody
Required
Description
extensions
2.3.2.1.3.8 Field callbacks
2.3.2.1.3.8.1 callbacks properties
PropertyValue
Name callbacks
Technical name
Type operationObject
2.3.2.1.4 get JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "get",
    "description": "Muliple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.",
    "properties": {
        "parameters": {
            "type": "array",
            "title": "parameters",
            "additionalItems": true,
            "items": {
                "type": "object",
                "description": "Tags to filter by",
                "properties": {
                    "schema": {
                        "type": "array",
                        "additionalItems": true,
                        "items": {
                            "type": "string"
                        }
                    },
                    "content": {
                        "type": "object",
                        "title": "content",
                        "additionalProperties": false
                    },
                    "examples": {
                        "type": "object",
                        "title": "examples",
                        "additionalProperties": false
                    }
                },
                "additionalProperties": false
            }
        },
        "requestBody": {
            "type": "object",
            "additionalProperties": false
        },
        "callbacks": {
            "type": "object",
            "additionalProperties": false
        }
    },
    "additionalProperties": true
}
2.3.2.1.5 get JSON data
{
    "parameters": [
        {
            "schema": [
                "Lorem"
            ],
            "content": {},
            "examples": {}
        }
    ],
    "requestBody": {},
    "callbacks": {}
}
2.3.2.1.6 get Responses:
2.3.2.1.6.1 Response 200
2.3.2.1.6.1.1 200 Tree Diagram
2.3.2.1.6.1.2 200 Properties
PropertyValue
Response200
Activatedtrue
Id
$ref
Description

successful operation

Resources/pets/findByTags
Parent requestget
Child response
Comments
extensions
[1] pattern
value
2.3.2.1.6.1.3 200 Fields
FieldTypeReqKeyDescriptionComments
responseresponsefalse

successful operation

headersobjectfalse
contentobjectfalse
application/xmlmediafalse
schemaarrayfalse
[0]objectfalse
idint64false
categorystringfalse
namestringtrue
photoUrlsarraytrue
[0]stringfalse
tagsarrayfalse
[0]stringfalse
statusstringfalse

pet status in the store

examplesobjectfalse
encodingobjectfalse
application/jsonmediafalse
schemaarrayfalse
[0]objectfalse
idint64false
categorystringfalse
namestringtrue
photoUrlsarraytrue
[0]stringfalse
tagsarrayfalse
[0]stringfalse
statusstringfalse

pet status in the store

examplesobjectfalse
encodingobjectfalse
linksobjectfalse
2.3.2.1.6.1.3.1 Field response
2.3.2.1.6.1.3.1.1 response Hierarchy
Parent field: 200
Child field(s):
FieldTypeReqKeyDescriptionComments
headersobjectfalse
contentobjectfalse
linksobjectfalse
2.3.2.1.6.1.3.1.2 response properties
PropertyValue
Type response
Comments
Description

successful operation

extensions
2.3.2.1.6.1.3.2 Field headers
2.3.2.1.6.1.3.2.1 headers properties
PropertyValue
Name headers
Technical name headers
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.3.2.1.6.1.3.3 Field content
2.3.2.1.6.1.3.3.1 content Hierarchy
Parent field: response
Child field(s):
FieldTypeReqKeyDescriptionComments
application/xmlmediafalse
application/jsonmediafalse
2.3.2.1.6.1.3.3.2 content properties
PropertyValue
Name content
Technical name content
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.3.2.1.6.1.3.4 Field application/xml
2.3.2.1.6.1.3.4.1 application/xml Hierarchy
Parent field: content
Child field(s):
FieldTypeReqKeyDescriptionComments
schemaarrayfalse
examplesobjectfalse
encodingobjectfalse
2.3.2.1.6.1.3.4.2 application/xml properties
PropertyValue
Name application/xml
Activated true
Description
Comments
example
Type media
extensions
2.3.2.1.6.1.3.5 Field schema
2.3.2.1.6.1.3.5.1 schema Hierarchy
Parent field: application/xml
Child field(s):
FieldTypeReqKeyDescriptionComments
[0]referencefalse
2.3.2.1.6.1.3.5.2 schema properties
PropertyValue
Name schema
Technical name
Activated true
Id
Type array
Title
Description
Required
Min items
Max items
Unique items
Additional items true
nullable
readOnly
writeOnly
xml
externalDocs
collectionFormat
example (deprecated)
Comments
2.3.2.1.6.1.3.6 Field [0]
2.3.2.1.6.1.3.6.1 [0] properties
PropertyValue
Name
Activated true
Reference type model
Reference description
2.3.2.1.6.1.3.7 Field examples
2.3.2.1.6.1.3.7.1 examples properties
PropertyValue
Name examples
Technical name examples
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.3.2.1.6.1.3.8 Field encoding
2.3.2.1.6.1.3.8.1 encoding properties
PropertyValue
Name encoding
Technical name encoding
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.3.2.1.6.1.3.9 Field application/json
2.3.2.1.6.1.3.9.1 application/json Hierarchy
Parent field: content
Child field(s):
FieldTypeReqKeyDescriptionComments
schemaarrayfalse
examplesobjectfalse
encodingobjectfalse
2.3.2.1.6.1.3.9.2 application/json properties
PropertyValue
Name application/json
Activated true
Description
Comments
example
Type media
extensions
2.3.2.1.6.1.3.10 Field schema
2.3.2.1.6.1.3.10.1 schema Hierarchy
Parent field: application/json
Child field(s):
FieldTypeReqKeyDescriptionComments
[0]referencefalse
2.3.2.1.6.1.3.10.2 schema properties
PropertyValue
Name schema
Technical name
Activated true
Id
Type array
Title
Description
Required
Min items
Max items
Unique items
Additional items true
nullable
readOnly
writeOnly
xml
externalDocs
collectionFormat
example (deprecated)
Comments
2.3.2.1.6.1.3.11 Field [0]
2.3.2.1.6.1.3.11.1 [0] properties
PropertyValue
Name
Activated true
Reference type model
Reference description
2.3.2.1.6.1.3.12 Field examples
2.3.2.1.6.1.3.12.1 examples properties
PropertyValue
Name examples
Technical name examples
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.3.2.1.6.1.3.13 Field encoding
2.3.2.1.6.1.3.13.1 encoding properties
PropertyValue
Name encoding
Technical name encoding
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.3.2.1.6.1.3.14 Field links
2.3.2.1.6.1.3.14.1 links properties
PropertyValue
Name links
Technical name links
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.3.2.1.6.1.4 200 JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "200",
    "description": "successful operation",
    "properties": {
        "response": {
            "type": "object",
            "description": "successful operation",
            "properties": {
                "headers": {
                    "type": "object",
                    "title": "headers",
                    "additionalProperties": false
                },
                "content": {
                    "type": "object",
                    "title": "content",
                    "properties": {
                        "application/xml": {
                            "type": "object",
                            "properties": {
                                "schema": {
                                    "type": "array",
                                    "additionalItems": true,
                                    "items": {
                                        "$ref": "#model/definitions/schemas/properties/Pet"
                                    }
                                },
                                "examples": {
                                    "type": "object",
                                    "title": "examples",
                                    "additionalProperties": false
                                },
                                "encoding": {
                                    "type": "object",
                                    "title": "encoding",
                                    "additionalProperties": false
                                }
                            },
                            "additionalProperties": false
                        },
                        "application/json": {
                            "type": "object",
                            "properties": {
                                "schema": {
                                    "type": "array",
                                    "additionalItems": true,
                                    "items": {
                                        "$ref": "#model/definitions/schemas/properties/Pet"
                                    }
                                },
                                "examples": {
                                    "type": "object",
                                    "title": "examples",
                                    "additionalProperties": false
                                },
                                "encoding": {
                                    "type": "object",
                                    "title": "encoding",
                                    "additionalProperties": false
                                }
                            },
                            "additionalProperties": false
                        }
                    },
                    "additionalProperties": false
                },
                "links": {
                    "type": "object",
                    "title": "links",
                    "additionalProperties": false
                }
            },
            "additionalProperties": false
        }
    },
    "additionalProperties": true
}
2.3.2.1.6.1.5 200 JSON data
{
    "response": {
        "headers": {},
        "content": {
            "application/xml": {
                "schema": [
                    {
                        "id": -100,
                        "category": "Lorem",
                        "name": "Lorem",
                        "photoUrls": [
                            "Lorem"
                        ],
                        "tags": [
                            "Lorem"
                        ],
                        "status": "sold"
                    }
                ],
                "examples": {},
                "encoding": {}
            },
            "application/json": {
                "schema": [
                    {
                        "id": 31,
                        "category": "Lorem",
                        "name": "Lorem",
                        "photoUrls": [
                            "Lorem"
                        ],
                        "tags": [
                            "Lorem"
                        ],
                        "status": "sold"
                    }
                ],
                "examples": {},
                "encoding": {}
            }
        },
        "links": {}
    }
}
2.3.2.1.6.2 Response 400
2.3.2.1.6.2.1 400 Tree Diagram
2.3.2.1.6.2.2 400 Properties
PropertyValue
Response400
Activatedtrue
Id
$ref
Description

Invalid tag value

Resources/pets/findByTags
Parent requestget
Child response
Comments
extensions
[1] pattern
value
2.3.2.1.6.2.3 400 Fields
FieldTypeReqKeyDescriptionComments
responseresponsefalse

Invalid tag value

headersobjectfalse
contentobjectfalse
linksobjectfalse
2.3.2.1.6.2.3.1 Field response
2.3.2.1.6.2.3.1.1 response Hierarchy
Parent field: 400
Child field(s):
FieldTypeReqKeyDescriptionComments
headersobjectfalse
contentobjectfalse
linksobjectfalse
2.3.2.1.6.2.3.1.2 response properties
PropertyValue
Type response
Comments
Description

Invalid tag value

extensions
2.3.2.1.6.2.3.2 Field headers
2.3.2.1.6.2.3.2.1 headers properties
PropertyValue
Name headers
Technical name headers
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.3.2.1.6.2.3.3 Field content
2.3.2.1.6.2.3.3.1 content properties
PropertyValue
Name content
Technical name content
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.3.2.1.6.2.3.4 Field links
2.3.2.1.6.2.3.4.1 links properties
PropertyValue
Name links
Technical name links
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.3.2.1.6.2.4 400 JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "400",
    "description": "Invalid tag value",
    "properties": {
        "response": {
            "type": "object",
            "description": "Invalid tag value",
            "properties": {
                "headers": {
                    "type": "object",
                    "title": "headers",
                    "additionalProperties": false
                },
                "content": {
                    "type": "object",
                    "title": "content",
                    "additionalProperties": false
                },
                "links": {
                    "type": "object",
                    "title": "links",
                    "additionalProperties": false
                }
            },
            "additionalProperties": false
        }
    },
    "additionalProperties": true
}
2.3.2.1.6.2.5 400 JSON data
{
    "response": {
        "headers": {},
        "content": {},
        "links": {}
    }
}
2.4 Resource /pets/{petId}
2.4.1 /pets/{petId} Properties
PropertyValue
Resource path/pets/{petId}
Activatedtrue
Description
summary
extensions
[1] pattern
value
Comments
2.4.2 /pets/{petId} Requests
2.4.2.1 Request delete
2.4.2.1.1 delete Tree Diagram
2.4.2.1.2 delete Properties
PropertyValue
Request operationdelete
Activatedtrue
Id
$ref
Description
Resources/pets/{petId}
Parent request
Child response
Comments
tags
[1] tagpets
summaryDeletes a pet
externalDocs
[1] url
description
extensions
operationIddeletePet
deprecated
security
[1] pattern {name}petstore_auth
operationwrite:petsread:pets
servers
[1] url
description
variables
extensions
extensions
[1] pattern
value
2.4.2.1.3 delete Fields
FieldTypeReqKeyDescriptionComments
parametersarrayfalse
[0] api_keyparameter (header)false
schemastringfalse
contentobjectfalse
examplesobjectfalse
[1] petIdparameter (path)true

Pet id to delete

schemaint64false
contentobjectfalse
examplesobjectfalse
requestBodyrequestBodyfalse
callbacksoperationObjectfalse
2.4.2.1.3.1 Field parameters
2.4.2.1.3.1.1 parameters Hierarchy
Parent field: delete
Child field(s):
FieldTypeReqKeyDescriptionComments
[0] api_keyparameter (header)false
[1] petIdparameter (path)true

Pet id to delete

2.4.2.1.3.1.2 parameters properties
PropertyValue
Name parameters
Technical name parameters
Id
Type array
Title
Description
Required
Min items
Max items
Unique items
Additional items true
Comments
2.4.2.1.3.2 Field [0] api_key
2.4.2.1.3.2.1 [0] api_key Hierarchy
Parent field: parameters
Child field(s):
FieldTypeReqKeyDescriptionComments
schemastringfalse
contentobjectfalse
examplesobjectfalse
2.4.2.1.3.2.2 [0] api_key properties
PropertyValue
Display name api_key
Activated true
Parameter name api_key
Type parameter (header)
Description
Comments
Required
Deprecated
Allow empty value
Style
Explode
Allow Reserved
example
extensions
2.4.2.1.3.3 Field schema
2.4.2.1.3.3.1 schema properties
PropertyValue
Name schema
Technical name
Activated true
Id
Type string
Format
Title
Description
Required
Deprecated
Default
Min length
Max length
Pattern
Enum
Faker function
example (deprecated)
nullable
readOnly
writeOnly
xml
externalDocs
Comments
2.4.2.1.3.4 Field content
2.4.2.1.3.4.1 content properties
PropertyValue
Name content
Technical name content
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.4.2.1.3.5 Field examples
2.4.2.1.3.5.1 examples properties
PropertyValue
Name examples
Technical name examples
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.4.2.1.3.6 Field [1] petId
2.4.2.1.3.6.1 [1] petId Hierarchy
Parent field: parameters
Child field(s):
FieldTypeReqKeyDescriptionComments
schemaintegerfalse
contentobjectfalse
examplesobjectfalse
2.4.2.1.3.6.2 [1] petId properties
PropertyValue
Display name petId
Activated true
Parameter name petId
Type parameter (path)
Description

Pet id to delete

Comments
Required true
Deprecated
Allow empty value
Style
Explode
Allow Reserved
example
extensions
2.4.2.1.3.7 Field schema
2.4.2.1.3.7.1 schema properties
PropertyValue
Name schema
Technical name
Activated true
Id
Type integer
Format int64
Title
Description
Required
Deprecated
Default
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Faker function
example (deprecated)
nullable
readOnly
xml
externalDocs
Comments
2.4.2.1.3.8 Field content
2.4.2.1.3.8.1 content properties
PropertyValue
Name content
Technical name content
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.4.2.1.3.9 Field examples
2.4.2.1.3.9.1 examples properties
PropertyValue
Name examples
Technical name examples
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.4.2.1.3.10 Field requestBody
2.4.2.1.3.10.1 requestBody properties
PropertyValue
Name requestBody
Technical name
Comments
Type requestBody
Required
Description
extensions
2.4.2.1.3.11 Field callbacks
2.4.2.1.3.11.1 callbacks properties
PropertyValue
Name callbacks
Technical name
Type operationObject
2.4.2.1.4 delete JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "delete",
    "properties": {
        "parameters": {
            "type": "array",
            "title": "parameters",
            "additionalItems": true,
            "items": [
                {
                    "type": "object",
                    "properties": {
                        "schema": {
                            "type": "string"
                        },
                        "content": {
                            "type": "object",
                            "title": "content",
                            "additionalProperties": false
                        },
                        "examples": {
                            "type": "object",
                            "title": "examples",
                            "additionalProperties": false
                        }
                    },
                    "additionalProperties": false
                },
                {
                    "type": "object",
                    "description": "Pet id to delete",
                    "properties": {
                        "schema": {
                            "type": "number"
                        },
                        "content": {
                            "type": "object",
                            "title": "content",
                            "additionalProperties": false
                        },
                        "examples": {
                            "type": "object",
                            "title": "examples",
                            "additionalProperties": false
                        }
                    },
                    "additionalProperties": false
                }
            ]
        },
        "requestBody": {
            "type": "object",
            "additionalProperties": false
        },
        "callbacks": {
            "type": "object",
            "additionalProperties": false
        }
    },
    "additionalProperties": true
}
2.4.2.1.5 delete JSON data
{
    "parameters": [
        {
            "schema": "Lorem",
            "content": {},
            "examples": {}
        },
        {
            "schema": -21,
            "content": {},
            "examples": {}
        }
    ],
    "requestBody": {},
    "callbacks": {}
}
2.4.2.1.6 delete Responses:
2.4.2.1.6.1 Response 400
2.4.2.1.6.1.1 400 Tree Diagram
2.4.2.1.6.1.2 400 Properties
PropertyValue
Response400
Activatedtrue
Id
$ref
Description

Invalid ID supplied

Resources/pets/{petId}
Parent requestdelete
Child response
Comments
extensions
[1] pattern
value
2.4.2.1.6.1.3 400 Fields
FieldTypeReqKeyDescriptionComments
responseresponsefalse

Invalid ID supplied

headersobjectfalse
contentobjectfalse
linksobjectfalse
2.4.2.1.6.1.3.1 Field response
2.4.2.1.6.1.3.1.1 response Hierarchy
Parent field: 400
Child field(s):
FieldTypeReqKeyDescriptionComments
headersobjectfalse
contentobjectfalse
linksobjectfalse
2.4.2.1.6.1.3.1.2 response properties
PropertyValue
Type response
Comments
Description

Invalid ID supplied

extensions
2.4.2.1.6.1.3.2 Field headers
2.4.2.1.6.1.3.2.1 headers properties
PropertyValue
Name headers
Technical name headers
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.4.2.1.6.1.3.3 Field content
2.4.2.1.6.1.3.3.1 content properties
PropertyValue
Name content
Technical name content
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.4.2.1.6.1.3.4 Field links
2.4.2.1.6.1.3.4.1 links properties
PropertyValue
Name links
Technical name links
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.4.2.1.6.1.4 400 JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "400",
    "description": "Invalid ID supplied",
    "properties": {
        "response": {
            "type": "object",
            "description": "Invalid ID supplied",
            "properties": {
                "headers": {
                    "type": "object",
                    "title": "headers",
                    "additionalProperties": false
                },
                "content": {
                    "type": "object",
                    "title": "content",
                    "additionalProperties": false
                },
                "links": {
                    "type": "object",
                    "title": "links",
                    "additionalProperties": false
                }
            },
            "additionalProperties": false
        }
    },
    "additionalProperties": true
}
2.4.2.1.6.1.5 400 JSON data
{
    "response": {
        "headers": {},
        "content": {},
        "links": {}
    }
}
2.4.2.1.6.2 Response 404
2.4.2.1.6.2.1 404 Tree Diagram
2.4.2.1.6.2.2 404 Properties
PropertyValue
Response404
Activatedtrue
Id
$ref
Description

Pet not found

Resources/pets/{petId}
Parent requestdelete
Child response
Comments
extensions
[1] pattern
value
2.4.2.1.6.2.3 404 Fields
FieldTypeReqKeyDescriptionComments
responseresponsefalse

Pet not found

headersobjectfalse
contentobjectfalse
linksobjectfalse
2.4.2.1.6.2.3.1 Field response
2.4.2.1.6.2.3.1.1 response Hierarchy
Parent field: 404
Child field(s):
FieldTypeReqKeyDescriptionComments
headersobjectfalse
contentobjectfalse
linksobjectfalse
2.4.2.1.6.2.3.1.2 response properties
PropertyValue
Type response
Comments
Description

Pet not found

extensions
2.4.2.1.6.2.3.2 Field headers
2.4.2.1.6.2.3.2.1 headers properties
PropertyValue
Name headers
Technical name headers
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.4.2.1.6.2.3.3 Field content
2.4.2.1.6.2.3.3.1 content properties
PropertyValue
Name content
Technical name content
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.4.2.1.6.2.3.4 Field links
2.4.2.1.6.2.3.4.1 links properties
PropertyValue
Name links
Technical name links
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.4.2.1.6.2.4 404 JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "404",
    "description": "Pet not found",
    "properties": {
        "response": {
            "type": "object",
            "description": "Pet not found",
            "properties": {
                "headers": {
                    "type": "object",
                    "title": "headers",
                    "additionalProperties": false
                },
                "content": {
                    "type": "object",
                    "title": "content",
                    "additionalProperties": false
                },
                "links": {
                    "type": "object",
                    "title": "links",
                    "additionalProperties": false
                }
            },
            "additionalProperties": false
        }
    },
    "additionalProperties": true
}
2.4.2.1.6.2.5 404 JSON data
{
    "response": {
        "headers": {},
        "content": {},
        "links": {}
    }
}
2.4.2.2 Request get
2.4.2.2.1 get Tree Diagram
2.4.2.2.2 get Properties
PropertyValue
Request operationget
Activatedtrue
Id
$ref
Description

Returns a single pet

Resources/pets/{petId}
Parent request
Child response
Comments
tags
[1] tagpets
summaryFind pet by ID
externalDocs
[1] url
description
extensions
operationIdgetPetById
deprecated
security
[1] pattern {name}api_key
operation
servers
[1] url
description
variables
extensions
extensions
[1] pattern
value
2.4.2.2.3 get Fields
FieldTypeReqKeyDescriptionComments
parametersarrayfalse
[0] petIdparameter (path)true

ID of pet to return

schemaint64false
contentobjectfalse
examplesobjectfalse
requestBodyrequestBodyfalse
callbacksoperationObjectfalse
2.4.2.2.3.1 Field parameters
2.4.2.2.3.1.1 parameters Hierarchy
Parent field: get
Child field(s):
FieldTypeReqKeyDescriptionComments
[0] petIdparameter (path)true

ID of pet to return

2.4.2.2.3.1.2 parameters properties
PropertyValue
Name parameters
Technical name parameters
Id
Type array
Title
Description
Required
Min items
Max items
Unique items
Additional items true
Comments
2.4.2.2.3.2 Field [0] petId
2.4.2.2.3.2.1 [0] petId Hierarchy
Parent field: parameters
Child field(s):
FieldTypeReqKeyDescriptionComments
schemaintegerfalse
contentobjectfalse
examplesobjectfalse
2.4.2.2.3.2.2 [0] petId properties
PropertyValue
Display name petId
Activated true
Parameter name petId
Type parameter (path)
Description

ID of pet to return

Comments
Required true
Deprecated
Allow empty value
Style
Explode
Allow Reserved
example
extensions
2.4.2.2.3.3 Field schema
2.4.2.2.3.3.1 schema properties
PropertyValue
Name schema
Technical name
Activated true
Id
Type integer
Format int64
Title
Description
Required
Deprecated
Default
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Faker function
example (deprecated)
nullable
readOnly
xml
externalDocs
Comments
2.4.2.2.3.4 Field content
2.4.2.2.3.4.1 content properties
PropertyValue
Name content
Technical name content
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.4.2.2.3.5 Field examples
2.4.2.2.3.5.1 examples properties
PropertyValue
Name examples
Technical name examples
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.4.2.2.3.6 Field requestBody
2.4.2.2.3.6.1 requestBody properties
PropertyValue
Name requestBody
Technical name
Comments
Type requestBody
Required
Description
extensions
2.4.2.2.3.7 Field callbacks
2.4.2.2.3.7.1 callbacks properties
PropertyValue
Name callbacks
Technical name
Type operationObject
2.4.2.2.4 get JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "get",
    "description": "Returns a single pet",
    "properties": {
        "parameters": {
            "type": "array",
            "title": "parameters",
            "additionalItems": true,
            "items": {
                "type": "object",
                "description": "ID of pet to return",
                "properties": {
                    "schema": {
                        "type": "number"
                    },
                    "content": {
                        "type": "object",
                        "title": "content",
                        "additionalProperties": false
                    },
                    "examples": {
                        "type": "object",
                        "title": "examples",
                        "additionalProperties": false
                    }
                },
                "additionalProperties": false
            }
        },
        "requestBody": {
            "type": "object",
            "additionalProperties": false
        },
        "callbacks": {
            "type": "object",
            "additionalProperties": false
        }
    },
    "additionalProperties": true
}
2.4.2.2.5 get JSON data
{
    "parameters": [
        {
            "schema": 39,
            "content": {},
            "examples": {}
        }
    ],
    "requestBody": {},
    "callbacks": {}
}
2.4.2.2.6 get Responses:
2.4.2.2.6.1 Response 200
2.4.2.2.6.1.1 200 Tree Diagram
2.4.2.2.6.1.2 200 Properties
PropertyValue
Response200
Activatedtrue
Id
$ref
Description

successful operation

Resources/pets/{petId}
Parent requestget
Child response
Comments
extensions
[1] pattern
value
2.4.2.2.6.1.3 200 Fields
FieldTypeReqKeyDescriptionComments
responseresponsefalse

successful operation

headersobjectfalse
contentobjectfalse
application/jsonmediafalse
schemaobjectfalse
idint64false
categorystringfalse
namestringtrue
photoUrlsarraytrue
[0]stringfalse
tagsarrayfalse
[0]stringfalse
statusstringfalse

pet status in the store

examplesobjectfalse
encodingobjectfalse
application/xmlmediafalse
schemaobjectfalse
idint64false
categorystringfalse
namestringtrue
photoUrlsarraytrue
[0]stringfalse
tagsarrayfalse
[0]stringfalse
statusstringfalse

pet status in the store

examplesobjectfalse
encodingobjectfalse
linksobjectfalse
2.4.2.2.6.1.3.1 Field response
2.4.2.2.6.1.3.1.1 response Hierarchy
Parent field: 200
Child field(s):
FieldTypeReqKeyDescriptionComments
headersobjectfalse
contentobjectfalse
linksobjectfalse
2.4.2.2.6.1.3.1.2 response properties
PropertyValue
Type response
Comments
Description

successful operation

extensions
2.4.2.2.6.1.3.2 Field headers
2.4.2.2.6.1.3.2.1 headers properties
PropertyValue
Name headers
Technical name headers
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.4.2.2.6.1.3.3 Field content
2.4.2.2.6.1.3.3.1 content Hierarchy
Parent field: response
Child field(s):
FieldTypeReqKeyDescriptionComments
application/jsonmediafalse
application/xmlmediafalse
2.4.2.2.6.1.3.3.2 content properties
PropertyValue
Name content
Technical name content
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.4.2.2.6.1.3.4 Field application/json
2.4.2.2.6.1.3.4.1 application/json Hierarchy
Parent field: content
Child field(s):
FieldTypeReqKeyDescriptionComments
schemareferencefalse
examplesobjectfalse
encodingobjectfalse
2.4.2.2.6.1.3.4.2 application/json properties
PropertyValue
Name application/json
Activated true
Description
Comments
example
Type media
extensions
2.4.2.2.6.1.3.5 Field schema
2.4.2.2.6.1.3.5.1 schema properties
PropertyValue
Name schema
Technical name
Activated true
Reference type model
Reference description
2.4.2.2.6.1.3.6 Field examples
2.4.2.2.6.1.3.6.1 examples properties
PropertyValue
Name examples
Technical name examples
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.4.2.2.6.1.3.7 Field encoding
2.4.2.2.6.1.3.7.1 encoding properties
PropertyValue
Name encoding
Technical name encoding
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.4.2.2.6.1.3.8 Field application/xml
2.4.2.2.6.1.3.8.1 application/xml Hierarchy
Parent field: content
Child field(s):
FieldTypeReqKeyDescriptionComments
schemareferencefalse
examplesobjectfalse
encodingobjectfalse
2.4.2.2.6.1.3.8.2 application/xml properties
PropertyValue
Name application/xml
Activated true
Description
Comments
example
Type media
extensions
2.4.2.2.6.1.3.9 Field schema
2.4.2.2.6.1.3.9.1 schema properties
PropertyValue
Name schema
Technical name
Activated true
Reference type model
Reference description
2.4.2.2.6.1.3.10 Field examples
2.4.2.2.6.1.3.10.1 examples properties
PropertyValue
Name examples
Technical name examples
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.4.2.2.6.1.3.11 Field encoding
2.4.2.2.6.1.3.11.1 encoding properties
PropertyValue
Name encoding
Technical name encoding
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.4.2.2.6.1.3.12 Field links
2.4.2.2.6.1.3.12.1 links properties
PropertyValue
Name links
Technical name links
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.4.2.2.6.1.4 200 JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "200",
    "description": "successful operation",
    "properties": {
        "response": {
            "type": "object",
            "description": "successful operation",
            "properties": {
                "headers": {
                    "type": "object",
                    "title": "headers",
                    "additionalProperties": false
                },
                "content": {
                    "type": "object",
                    "title": "content",
                    "properties": {
                        "application/json": {
                            "type": "object",
                            "properties": {
                                "schema": {
                                    "$ref": "#model/definitions/schemas/properties/Pet"
                                },
                                "examples": {
                                    "type": "object",
                                    "title": "examples",
                                    "additionalProperties": false
                                },
                                "encoding": {
                                    "type": "object",
                                    "title": "encoding",
                                    "additionalProperties": false
                                }
                            },
                            "additionalProperties": false
                        },
                        "application/xml": {
                            "type": "object",
                            "properties": {
                                "schema": {
                                    "$ref": "#model/definitions/schemas/properties/Pet"
                                },
                                "examples": {
                                    "type": "object",
                                    "title": "examples",
                                    "additionalProperties": false
                                },
                                "encoding": {
                                    "type": "object",
                                    "title": "encoding",
                                    "additionalProperties": false
                                }
                            },
                            "additionalProperties": false
                        }
                    },
                    "additionalProperties": false
                },
                "links": {
                    "type": "object",
                    "title": "links",
                    "additionalProperties": false
                }
            },
            "additionalProperties": false
        }
    },
    "additionalProperties": true
}
2.4.2.2.6.1.5 200 JSON data
{
    "response": {
        "headers": {},
        "content": {
            "application/json": {
                "schema": {
                    "id": 9,
                    "category": "Lorem",
                    "name": "Lorem",
                    "photoUrls": [
                        "Lorem"
                    ],
                    "tags": [
                        "Lorem"
                    ],
                    "status": "sold"
                },
                "examples": {},
                "encoding": {}
            },
            "application/xml": {
                "schema": {
                    "id": 95,
                    "category": "Lorem",
                    "name": "Lorem",
                    "photoUrls": [
                        "Lorem"
                    ],
                    "tags": [
                        "Lorem"
                    ],
                    "status": "sold"
                },
                "examples": {},
                "encoding": {}
            }
        },
        "links": {}
    }
}
2.4.2.2.6.2 Response 400
2.4.2.2.6.2.1 400 Tree Diagram
2.4.2.2.6.2.2 400 Properties
PropertyValue
Response400
Activatedtrue
Id
$ref
Description

Invalid ID supplied

Resources/pets/{petId}
Parent requestget
Child response
Comments
extensions
[1] pattern
value
2.4.2.2.6.2.3 400 Fields
FieldTypeReqKeyDescriptionComments
responseresponsefalse

Invalid ID supplied

headersobjectfalse
contentobjectfalse
linksobjectfalse
2.4.2.2.6.2.3.1 Field response
2.4.2.2.6.2.3.1.1 response Hierarchy
Parent field: 400
Child field(s):
FieldTypeReqKeyDescriptionComments
headersobjectfalse
contentobjectfalse
linksobjectfalse
2.4.2.2.6.2.3.1.2 response properties
PropertyValue
Type response
Comments
Description

Invalid ID supplied

extensions
2.4.2.2.6.2.3.2 Field headers
2.4.2.2.6.2.3.2.1 headers properties
PropertyValue
Name headers
Technical name headers
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.4.2.2.6.2.3.3 Field content
2.4.2.2.6.2.3.3.1 content properties
PropertyValue
Name content
Technical name content
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.4.2.2.6.2.3.4 Field links
2.4.2.2.6.2.3.4.1 links properties
PropertyValue
Name links
Technical name links
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.4.2.2.6.2.4 400 JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "400",
    "description": "Invalid ID supplied",
    "properties": {
        "response": {
            "type": "object",
            "description": "Invalid ID supplied",
            "properties": {
                "headers": {
                    "type": "object",
                    "title": "headers",
                    "additionalProperties": false
                },
                "content": {
                    "type": "object",
                    "title": "content",
                    "additionalProperties": false
                },
                "links": {
                    "type": "object",
                    "title": "links",
                    "additionalProperties": false
                }
            },
            "additionalProperties": false
        }
    },
    "additionalProperties": true
}
2.4.2.2.6.2.5 400 JSON data
{
    "response": {
        "headers": {},
        "content": {},
        "links": {}
    }
}
2.4.2.2.6.3 Response 404
2.4.2.2.6.3.1 404 Tree Diagram
2.4.2.2.6.3.2 404 Properties
PropertyValue
Response404
Activatedtrue
Id
$ref
Description

Pet not found

Resources/pets/{petId}
Parent requestget
Child response
Comments
extensions
[1] pattern
value
2.4.2.2.6.3.3 404 Fields
FieldTypeReqKeyDescriptionComments
responseresponsefalse

Pet not found

headersobjectfalse
contentobjectfalse
linksobjectfalse
2.4.2.2.6.3.3.1 Field response
2.4.2.2.6.3.3.1.1 response Hierarchy
Parent field: 404
Child field(s):
FieldTypeReqKeyDescriptionComments
headersobjectfalse
contentobjectfalse
linksobjectfalse
2.4.2.2.6.3.3.1.2 response properties
PropertyValue
Type response
Comments
Description

Pet not found

extensions
2.4.2.2.6.3.3.2 Field headers
2.4.2.2.6.3.3.2.1 headers properties
PropertyValue
Name headers
Technical name headers
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.4.2.2.6.3.3.3 Field content
2.4.2.2.6.3.3.3.1 content properties
PropertyValue
Name content
Technical name content
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.4.2.2.6.3.3.4 Field links
2.4.2.2.6.3.3.4.1 links properties
PropertyValue
Name links
Technical name links
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.4.2.2.6.3.4 404 JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "404",
    "description": "Pet not found",
    "properties": {
        "response": {
            "type": "object",
            "description": "Pet not found",
            "properties": {
                "headers": {
                    "type": "object",
                    "title": "headers",
                    "additionalProperties": false
                },
                "content": {
                    "type": "object",
                    "title": "content",
                    "additionalProperties": false
                },
                "links": {
                    "type": "object",
                    "title": "links",
                    "additionalProperties": false
                }
            },
            "additionalProperties": false
        }
    },
    "additionalProperties": true
}
2.4.2.2.6.3.5 404 JSON data
{
    "response": {
        "headers": {},
        "content": {},
        "links": {}
    }
}
2.4.2.3 Request post
2.4.2.3.1 post Tree Diagram
2.4.2.3.2 post Properties
PropertyValue
Request operationpost
Activatedtrue
Id
$ref
Description
Resources/pets/{petId}
Parent request
Child response
Comments
tags
[1] tagpets
summaryUpdates a pet in the store with form data
externalDocs
[1] url
description
extensions
operationIdupdatePetWithForm
deprecated
security
[1] pattern {name}petstore_auth
operationwrite:petsread:pets
servers
[1] url
description
variables
extensions
extensions
[1] pattern
value
2.4.2.3.3 post Fields
FieldTypeReqKeyDescriptionComments
parametersarrayfalse
[0] petIdparameter (path)true

ID of pet that needs to be updated

schemaint64false
contentobjectfalse
examplesobjectfalse
requestBodyrequestBodyfalse
application/x-www-form-urlencodedmediafalse
schemaobjectfalse
namestringfalse

Updated name of the pet

statusstringfalse

Updated status of the pet

examplesobjectfalse
encodingobjectfalse
callbacksoperationObjectfalse
2.4.2.3.3.1 Field parameters
2.4.2.3.3.1.1 parameters Hierarchy
Parent field: post
Child field(s):
FieldTypeReqKeyDescriptionComments
[0] petIdparameter (path)true

ID of pet that needs to be updated

2.4.2.3.3.1.2 parameters properties
PropertyValue
Name parameters
Technical name parameters
Id
Type array
Title
Description
Required
Min items
Max items
Unique items
Additional items true
Comments
2.4.2.3.3.2 Field [0] petId
2.4.2.3.3.2.1 [0] petId Hierarchy
Parent field: parameters
Child field(s):
FieldTypeReqKeyDescriptionComments
schemaintegerfalse
contentobjectfalse
examplesobjectfalse
2.4.2.3.3.2.2 [0] petId properties
PropertyValue
Display name petId
Activated true
Parameter name petId
Type parameter (path)
Description

ID of pet that needs to be updated

Comments
Required true
Deprecated
Allow empty value
Style
Explode
Allow Reserved
example
extensions
2.4.2.3.3.3 Field schema
2.4.2.3.3.3.1 schema properties
PropertyValue
Name schema
Technical name
Activated true
Id
Type integer
Format int64
Title
Description
Required
Deprecated
Default
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Faker function
example (deprecated)
nullable
readOnly
xml
externalDocs
Comments
2.4.2.3.3.4 Field content
2.4.2.3.3.4.1 content properties
PropertyValue
Name content
Technical name content
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.4.2.3.3.5 Field examples
2.4.2.3.3.5.1 examples properties
PropertyValue
Name examples
Technical name examples
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.4.2.3.3.6 Field requestBody
2.4.2.3.3.6.1 requestBody Hierarchy
Parent field: post
Child field(s):
FieldTypeReqKeyDescriptionComments
application/x-www-form-urlencodedmediafalse
2.4.2.3.3.6.2 requestBody properties
PropertyValue
Name requestBody
Technical name
Comments
Type requestBody
Required
Description
extensions
2.4.2.3.3.7 Field application/x-www-form-urlencoded
2.4.2.3.3.7.1 application/x-www-form-urlencoded Hierarchy
Parent field: requestBody
Child field(s):
FieldTypeReqKeyDescriptionComments
schemaobjectfalse
examplesobjectfalse
encodingobjectfalse
2.4.2.3.3.7.2 application/x-www-form-urlencoded properties
PropertyValue
Name application/x-www-form-urlencoded
Activated true
Description
Comments
example
Type media
extensions
2.4.2.3.3.8 Field schema
2.4.2.3.3.8.1 schema Hierarchy
Parent field: application/x-www-form-urlencoded
Child field(s):
FieldTypeReqKeyDescriptionComments
namestringfalse

Updated name of the pet

statusstringfalse

Updated status of the pet

2.4.2.3.3.8.2 schema properties
PropertyValue
Name schema
Technical name
Activated true
Id
Type object
Title
Description
Required
Deprecated
Allow empty value
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
nullable
Discriminator
readOnly
writeOnly
xml
externalDocs
example (deprecated)
extensions
Comments
2.4.2.3.3.9 Field name
2.4.2.3.3.9.1 name properties
PropertyValue
Name name
Technical name
Activated true
Id
Type string
Format
Title
Description

Updated name of the pet

Required
Deprecated
Default
Min length
Max length
Pattern
Enum
Faker function
example (deprecated)
nullable
readOnly
writeOnly
xml
externalDocs
Comments
2.4.2.3.3.10 Field status
2.4.2.3.3.10.1 status properties
PropertyValue
Name status
Technical name
Activated true
Id
Type string
Format
Title
Description

Updated status of the pet

Required
Deprecated
Default
Min length
Max length
Pattern
Enum
Faker function
example (deprecated)
nullable
readOnly
writeOnly
xml
externalDocs
Comments
2.4.2.3.3.11 Field examples
2.4.2.3.3.11.1 examples properties
PropertyValue
Name examples
Technical name examples
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.4.2.3.3.12 Field encoding
2.4.2.3.3.12.1 encoding properties
PropertyValue
Name encoding
Technical name encoding
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.4.2.3.3.13 Field callbacks
2.4.2.3.3.13.1 callbacks properties
PropertyValue
Name callbacks
Technical name
Type operationObject
2.4.2.3.4 post JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "post",
    "properties": {
        "parameters": {
            "type": "array",
            "title": "parameters",
            "additionalItems": true,
            "items": {
                "type": "object",
                "description": "ID of pet that needs to be updated",
                "properties": {
                    "schema": {
                        "type": "number"
                    },
                    "content": {
                        "type": "object",
                        "title": "content",
                        "additionalProperties": false
                    },
                    "examples": {
                        "type": "object",
                        "title": "examples",
                        "additionalProperties": false
                    }
                },
                "additionalProperties": false
            }
        },
        "requestBody": {
            "type": "object",
            "properties": {
                "application/x-www-form-urlencoded": {
                    "type": "object",
                    "properties": {
                        "schema": {
                            "type": "object",
                            "properties": {
                                "name": {
                                    "type": "string",
                                    "description": "Updated name of the pet"
                                },
                                "status": {
                                    "type": "string",
                                    "description": "Updated status of the pet"
                                }
                            },
                            "additionalProperties": false
                        },
                        "examples": {
                            "type": "object",
                            "title": "examples",
                            "additionalProperties": false
                        },
                        "encoding": {
                            "type": "object",
                            "title": "encoding",
                            "additionalProperties": false
                        }
                    },
                    "additionalProperties": false
                }
            },
            "additionalProperties": false
        },
        "callbacks": {
            "type": "object",
            "additionalProperties": false
        }
    },
    "additionalProperties": true
}
2.4.2.3.5 post JSON data
{
    "parameters": [
        {
            "schema": 18,
            "content": {},
            "examples": {}
        }
    ],
    "requestBody": {
        "application/x-www-form-urlencoded": {
            "schema": {
                "name": "Lorem",
                "status": "Lorem"
            },
            "examples": {},
            "encoding": {}
        }
    },
    "callbacks": {}
}
2.4.2.3.6 post Responses:
2.4.2.3.6.1 Response 405
2.4.2.3.6.1.1 405 Tree Diagram
2.4.2.3.6.1.2 405 Properties
PropertyValue
Response405
Activatedtrue
Id
$ref
Description

Invalid input

Resources/pets/{petId}
Parent requestpost
Child response
Comments
extensions
[1] pattern
value
2.4.2.3.6.1.3 405 Fields
FieldTypeReqKeyDescriptionComments
responseresponsefalse

Invalid input

headersobjectfalse
contentobjectfalse
linksobjectfalse
2.4.2.3.6.1.3.1 Field response
2.4.2.3.6.1.3.1.1 response Hierarchy
Parent field: 405
Child field(s):
FieldTypeReqKeyDescriptionComments
headersobjectfalse
contentobjectfalse
linksobjectfalse
2.4.2.3.6.1.3.1.2 response properties
PropertyValue
Type response
Comments
Description

Invalid input

extensions
2.4.2.3.6.1.3.2 Field headers
2.4.2.3.6.1.3.2.1 headers properties
PropertyValue
Name headers
Technical name headers
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.4.2.3.6.1.3.3 Field content
2.4.2.3.6.1.3.3.1 content properties
PropertyValue
Name content
Technical name content
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.4.2.3.6.1.3.4 Field links
2.4.2.3.6.1.3.4.1 links properties
PropertyValue
Name links
Technical name links
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.4.2.3.6.1.4 405 JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "405",
    "description": "Invalid input",
    "properties": {
        "response": {
            "type": "object",
            "description": "Invalid input",
            "properties": {
                "headers": {
                    "type": "object",
                    "title": "headers",
                    "additionalProperties": false
                },
                "content": {
                    "type": "object",
                    "title": "content",
                    "additionalProperties": false
                },
                "links": {
                    "type": "object",
                    "title": "links",
                    "additionalProperties": false
                }
            },
            "additionalProperties": false
        }
    },
    "additionalProperties": true
}
2.4.2.3.6.1.5 405 JSON data
{
    "response": {
        "headers": {},
        "content": {},
        "links": {}
    }
}
2.5 Resource /pets/{petId}(1)
2.5.1 /pets/{petId}(1) Properties
PropertyValue
Resource path/pets/{petId}(1)
Activatedtrue
Description
summary
extensions
[1] pattern
value
Comments
2.5.2 /pets/{petId}(1) Requests
2.5.2.1 Request delete
2.5.2.1.1 delete Tree Diagram
2.5.2.1.2 delete Properties
PropertyValue
Request operationdelete
Activatedtrue
Id
$ref
Description
Resources/pets/{petId}(1)
Parent request
Child response
Comments
tags
[1] tagpets
summaryDeletes a pet
externalDocs
[1] url
description
extensions
operationIddeletePet
deprecated
security
[1] pattern {name}petstore_auth
operationwrite:petsread:pets
servers
[1] url
description
variables
extensions
extensions
[1] pattern
value
2.5.2.1.3 delete Fields
FieldTypeReqKeyDescriptionComments
parametersarrayfalse
[0] api_keyparameter (header)false
schemastringfalse
contentobjectfalse
examplesobjectfalse
[1] petIdparameter (path)true

Pet id to delete

schemaint64false
contentobjectfalse
examplesobjectfalse
requestBodyrequestBodyfalse
callbacksoperationObjectfalse
2.5.2.1.3.1 Field parameters
2.5.2.1.3.1.1 parameters Hierarchy
Parent field: delete
Child field(s):
FieldTypeReqKeyDescriptionComments
[0] api_keyparameter (header)false
[1] petIdparameter (path)true

Pet id to delete

2.5.2.1.3.1.2 parameters properties
PropertyValue
Name parameters
Technical name parameters
Id
Type array
Title
Description
Required
Min items
Max items
Unique items
Additional items true
Comments
2.5.2.1.3.2 Field [0] api_key
2.5.2.1.3.2.1 [0] api_key Hierarchy
Parent field: parameters
Child field(s):
FieldTypeReqKeyDescriptionComments
schemastringfalse
contentobjectfalse
examplesobjectfalse
2.5.2.1.3.2.2 [0] api_key properties
PropertyValue
Display name api_key
Activated true
Parameter name api_key
Type parameter (header)
Description
Comments
Required
Deprecated
Allow empty value
Style
Explode
Allow Reserved
example
extensions
2.5.2.1.3.3 Field schema
2.5.2.1.3.3.1 schema properties
PropertyValue
Name schema
Technical name
Activated true
Id
Type string
Format
Title
Description
Required
Deprecated
Default
Min length
Max length
Pattern
Enum
Faker function
example (deprecated)
nullable
readOnly
writeOnly
xml
externalDocs
Comments
2.5.2.1.3.4 Field content
2.5.2.1.3.4.1 content properties
PropertyValue
Name content
Technical name content
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.5.2.1.3.5 Field examples
2.5.2.1.3.5.1 examples properties
PropertyValue
Name examples
Technical name examples
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.5.2.1.3.6 Field [1] petId
2.5.2.1.3.6.1 [1] petId Hierarchy
Parent field: parameters
Child field(s):
FieldTypeReqKeyDescriptionComments
schemaintegerfalse
contentobjectfalse
examplesobjectfalse
2.5.2.1.3.6.2 [1] petId properties
PropertyValue
Display name petId
Activated true
Parameter name petId
Type parameter (path)
Description

Pet id to delete

Comments
Required true
Deprecated
Allow empty value
Style
Explode
Allow Reserved
example
extensions
2.5.2.1.3.7 Field schema
2.5.2.1.3.7.1 schema properties
PropertyValue
Name schema
Technical name
Activated true
Id
Type integer
Format int64
Title
Description
Required
Deprecated
Default
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Faker function
example (deprecated)
nullable
readOnly
xml
externalDocs
Comments
2.5.2.1.3.8 Field content
2.5.2.1.3.8.1 content properties
PropertyValue
Name content
Technical name content
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.5.2.1.3.9 Field examples
2.5.2.1.3.9.1 examples properties
PropertyValue
Name examples
Technical name examples
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.5.2.1.3.10 Field requestBody
2.5.2.1.3.10.1 requestBody properties
PropertyValue
Name requestBody
Technical name
Comments
Type requestBody
Required
Description
extensions
2.5.2.1.3.11 Field callbacks
2.5.2.1.3.11.1 callbacks properties
PropertyValue
Name callbacks
Technical name
Type operationObject
2.5.2.1.4 delete JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "delete",
    "properties": {
        "parameters": {
            "type": "array",
            "title": "parameters",
            "additionalItems": true,
            "items": [
                {
                    "type": "object",
                    "properties": {
                        "schema": {
                            "type": "string"
                        },
                        "content": {
                            "type": "object",
                            "title": "content",
                            "additionalProperties": false
                        },
                        "examples": {
                            "type": "object",
                            "title": "examples",
                            "additionalProperties": false
                        }
                    },
                    "additionalProperties": false
                },
                {
                    "type": "object",
                    "description": "Pet id to delete",
                    "properties": {
                        "schema": {
                            "type": "number"
                        },
                        "content": {
                            "type": "object",
                            "title": "content",
                            "additionalProperties": false
                        },
                        "examples": {
                            "type": "object",
                            "title": "examples",
                            "additionalProperties": false
                        }
                    },
                    "additionalProperties": false
                }
            ]
        },
        "requestBody": {
            "type": "object",
            "additionalProperties": false
        },
        "callbacks": {
            "type": "object",
            "additionalProperties": false
        }
    },
    "additionalProperties": true
}
2.5.2.1.5 delete JSON data
{
    "parameters": [
        {
            "schema": "Lorem",
            "content": {},
            "examples": {}
        },
        {
            "schema": 91,
            "content": {},
            "examples": {}
        }
    ],
    "requestBody": {},
    "callbacks": {}
}
2.5.2.1.6 delete Responses:
2.5.2.1.6.1 Response 400
2.5.2.1.6.1.1 400 Tree Diagram
2.5.2.1.6.1.2 400 Properties
PropertyValue
Response400
Activatedtrue
Id
$ref
Description

Invalid ID supplied

Resources/pets/{petId}(1)
Parent requestdelete
Child response
Comments
extensions
[1] pattern
value
2.5.2.1.6.1.3 400 Fields
FieldTypeReqKeyDescriptionComments
responseresponsefalse

Invalid ID supplied

headersobjectfalse
contentobjectfalse
linksobjectfalse
2.5.2.1.6.1.3.1 Field response
2.5.2.1.6.1.3.1.1 response Hierarchy
Parent field: 400
Child field(s):
FieldTypeReqKeyDescriptionComments
headersobjectfalse
contentobjectfalse
linksobjectfalse
2.5.2.1.6.1.3.1.2 response properties
PropertyValue
Type response
Comments
Description

Invalid ID supplied

extensions
2.5.2.1.6.1.3.2 Field headers
2.5.2.1.6.1.3.2.1 headers properties
PropertyValue
Name headers
Technical name headers
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.5.2.1.6.1.3.3 Field content
2.5.2.1.6.1.3.3.1 content properties
PropertyValue
Name content
Technical name content
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.5.2.1.6.1.3.4 Field links
2.5.2.1.6.1.3.4.1 links properties
PropertyValue
Name links
Technical name links
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.5.2.1.6.1.4 400 JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "400",
    "description": "Invalid ID supplied",
    "properties": {
        "response": {
            "type": "object",
            "description": "Invalid ID supplied",
            "properties": {
                "headers": {
                    "type": "object",
                    "title": "headers",
                    "additionalProperties": false
                },
                "content": {
                    "type": "object",
                    "title": "content",
                    "additionalProperties": false
                },
                "links": {
                    "type": "object",
                    "title": "links",
                    "additionalProperties": false
                }
            },
            "additionalProperties": false
        }
    },
    "additionalProperties": true
}
2.5.2.1.6.1.5 400 JSON data
{
    "response": {
        "headers": {},
        "content": {},
        "links": {}
    }
}
2.5.2.1.6.2 Response 404
2.5.2.1.6.2.1 404 Tree Diagram
2.5.2.1.6.2.2 404 Properties
PropertyValue
Response404
Activatedtrue
Id
$ref
Description

Pet not found

Resources/pets/{petId}(1)
Parent requestdelete
Child response
Comments
extensions
[1] pattern
value
2.5.2.1.6.2.3 404 Fields
FieldTypeReqKeyDescriptionComments
responseresponsefalse

Pet not found

headersobjectfalse
contentobjectfalse
linksobjectfalse
2.5.2.1.6.2.3.1 Field response
2.5.2.1.6.2.3.1.1 response Hierarchy
Parent field: 404
Child field(s):
FieldTypeReqKeyDescriptionComments
headersobjectfalse
contentobjectfalse
linksobjectfalse
2.5.2.1.6.2.3.1.2 response properties
PropertyValue
Type response
Comments
Description

Pet not found

extensions
2.5.2.1.6.2.3.2 Field headers
2.5.2.1.6.2.3.2.1 headers properties
PropertyValue
Name headers
Technical name headers
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.5.2.1.6.2.3.3 Field content
2.5.2.1.6.2.3.3.1 content properties
PropertyValue
Name content
Technical name content
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.5.2.1.6.2.3.4 Field links
2.5.2.1.6.2.3.4.1 links properties
PropertyValue
Name links
Technical name links
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.5.2.1.6.2.4 404 JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "404",
    "description": "Pet not found",
    "properties": {
        "response": {
            "type": "object",
            "description": "Pet not found",
            "properties": {
                "headers": {
                    "type": "object",
                    "title": "headers",
                    "additionalProperties": false
                },
                "content": {
                    "type": "object",
                    "title": "content",
                    "additionalProperties": false
                },
                "links": {
                    "type": "object",
                    "title": "links",
                    "additionalProperties": false
                }
            },
            "additionalProperties": false
        }
    },
    "additionalProperties": true
}
2.5.2.1.6.2.5 404 JSON data
{
    "response": {
        "headers": {},
        "content": {},
        "links": {}
    }
}
2.5.2.2 Request get
2.5.2.2.1 get Tree Diagram
2.5.2.2.2 get Properties
PropertyValue
Request operationget
Activatedtrue
Id
$ref
Description

Returns a single pet

Resources/pets/{petId}(1)
Parent request
Child response
Comments
tags
[1] tagpets
summaryFind pet by ID
externalDocs
[1] url
description
extensions
operationIdgetPetById
deprecated
security
[1] pattern {name}api_key
operation
servers
[1] url
description
variables
extensions
extensions
[1] pattern
value
2.5.2.2.3 get Fields
FieldTypeReqKeyDescriptionComments
parametersarrayfalse
[0] petIdparameter (path)true

ID of pet to return

schemaint64false
contentobjectfalse
examplesobjectfalse
requestBodyrequestBodyfalse
callbacksoperationObjectfalse
2.5.2.2.3.1 Field parameters
2.5.2.2.3.1.1 parameters Hierarchy
Parent field: get
Child field(s):
FieldTypeReqKeyDescriptionComments
[0] petIdparameter (path)true

ID of pet to return

2.5.2.2.3.1.2 parameters properties
PropertyValue
Name parameters
Technical name parameters
Id
Type array
Title
Description
Required
Min items
Max items
Unique items
Additional items true
Comments
2.5.2.2.3.2 Field [0] petId
2.5.2.2.3.2.1 [0] petId Hierarchy
Parent field: parameters
Child field(s):
FieldTypeReqKeyDescriptionComments
schemaintegerfalse
contentobjectfalse
examplesobjectfalse
2.5.2.2.3.2.2 [0] petId properties
PropertyValue
Display name petId
Activated true
Parameter name petId
Type parameter (path)
Description

ID of pet to return

Comments
Required true
Deprecated
Allow empty value
Style
Explode
Allow Reserved
example
extensions
2.5.2.2.3.3 Field schema
2.5.2.2.3.3.1 schema properties
PropertyValue
Name schema
Technical name
Activated true
Id
Type integer
Format int64
Title
Description
Required
Deprecated
Default
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Faker function
example (deprecated)
nullable
readOnly
xml
externalDocs
Comments
2.5.2.2.3.4 Field content
2.5.2.2.3.4.1 content properties
PropertyValue
Name content
Technical name content
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.5.2.2.3.5 Field examples
2.5.2.2.3.5.1 examples properties
PropertyValue
Name examples
Technical name examples
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.5.2.2.3.6 Field requestBody
2.5.2.2.3.6.1 requestBody properties
PropertyValue
Name requestBody
Technical name
Comments
Type requestBody
Required
Description
extensions
2.5.2.2.3.7 Field callbacks
2.5.2.2.3.7.1 callbacks properties
PropertyValue
Name callbacks
Technical name
Type operationObject
2.5.2.2.4 get JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "get",
    "description": "Returns a single pet",
    "properties": {
        "parameters": {
            "type": "array",
            "title": "parameters",
            "additionalItems": true,
            "items": {
                "type": "object",
                "description": "ID of pet to return",
                "properties": {
                    "schema": {
                        "type": "number"
                    },
                    "content": {
                        "type": "object",
                        "title": "content",
                        "additionalProperties": false
                    },
                    "examples": {
                        "type": "object",
                        "title": "examples",
                        "additionalProperties": false
                    }
                },
                "additionalProperties": false
            }
        },
        "requestBody": {
            "type": "object",
            "additionalProperties": false
        },
        "callbacks": {
            "type": "object",
            "additionalProperties": false
        }
    },
    "additionalProperties": true
}
2.5.2.2.5 get JSON data
{
    "parameters": [
        {
            "schema": 31,
            "content": {},
            "examples": {}
        }
    ],
    "requestBody": {},
    "callbacks": {}
}
2.5.2.2.6 get Responses:
2.5.2.2.6.1 Response 200
2.5.2.2.6.1.1 200 Tree Diagram
2.5.2.2.6.1.2 200 Properties
PropertyValue
Response200
Activatedtrue
Id
$ref
Description

successful operation

Resources/pets/{petId}(1)
Parent requestget
Child response
Comments
extensions
[1] pattern
value
2.5.2.2.6.1.3 200 Fields
FieldTypeReqKeyDescriptionComments
responseresponsefalse

successful operation

headersobjectfalse
contentobjectfalse
application/xmlmediafalse
schemaobjectfalse
idint64false
categorystringfalse
namestringtrue
photoUrlsarraytrue
[0]stringfalse
tagsarrayfalse
[0]stringfalse
statusstringfalse

pet status in the store

examplesobjectfalse
encodingobjectfalse
application/jsonmediafalse
schemaobjectfalse
idint64false
categorystringfalse
namestringtrue
photoUrlsarraytrue
[0]stringfalse
tagsarrayfalse
[0]stringfalse
statusstringfalse

pet status in the store

examplesobjectfalse
encodingobjectfalse
linksobjectfalse
2.5.2.2.6.1.3.1 Field response
2.5.2.2.6.1.3.1.1 response Hierarchy
Parent field: 200
Child field(s):
FieldTypeReqKeyDescriptionComments
headersobjectfalse
contentobjectfalse
linksobjectfalse
2.5.2.2.6.1.3.1.2 response properties
PropertyValue
Type response
Comments
Description

successful operation

extensions
2.5.2.2.6.1.3.2 Field headers
2.5.2.2.6.1.3.2.1 headers properties
PropertyValue
Name headers
Technical name headers
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.5.2.2.6.1.3.3 Field content
2.5.2.2.6.1.3.3.1 content Hierarchy
Parent field: response
Child field(s):
FieldTypeReqKeyDescriptionComments
application/xmlmediafalse
application/jsonmediafalse
2.5.2.2.6.1.3.3.2 content properties
PropertyValue
Name content
Technical name content
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.5.2.2.6.1.3.4 Field application/xml
2.5.2.2.6.1.3.4.1 application/xml Hierarchy
Parent field: content
Child field(s):
FieldTypeReqKeyDescriptionComments
schemareferencefalse
examplesobjectfalse
encodingobjectfalse
2.5.2.2.6.1.3.4.2 application/xml properties
PropertyValue
Name application/xml
Activated true
Description
Comments
example
Type media
extensions
2.5.2.2.6.1.3.5 Field schema
2.5.2.2.6.1.3.5.1 schema properties
PropertyValue
Name schema
Technical name
Activated true
Reference type model
Reference description
2.5.2.2.6.1.3.6 Field examples
2.5.2.2.6.1.3.6.1 examples properties
PropertyValue
Name examples
Technical name examples
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.5.2.2.6.1.3.7 Field encoding
2.5.2.2.6.1.3.7.1 encoding properties
PropertyValue
Name encoding
Technical name encoding
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.5.2.2.6.1.3.8 Field application/json
2.5.2.2.6.1.3.8.1 application/json Hierarchy
Parent field: content
Child field(s):
FieldTypeReqKeyDescriptionComments
schemareferencefalse
examplesobjectfalse
encodingobjectfalse
2.5.2.2.6.1.3.8.2 application/json properties
PropertyValue
Name application/json
Activated true
Description
Comments
example
Type media
extensions
2.5.2.2.6.1.3.9 Field schema
2.5.2.2.6.1.3.9.1 schema properties
PropertyValue
Name schema
Technical name
Activated true
Reference type model
Reference description
2.5.2.2.6.1.3.10 Field examples
2.5.2.2.6.1.3.10.1 examples properties
PropertyValue
Name examples
Technical name examples
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.5.2.2.6.1.3.11 Field encoding
2.5.2.2.6.1.3.11.1 encoding properties
PropertyValue
Name encoding
Technical name encoding
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.5.2.2.6.1.3.12 Field links
2.5.2.2.6.1.3.12.1 links properties
PropertyValue
Name links
Technical name links
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.5.2.2.6.1.4 200 JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "200",
    "description": "successful operation",
    "properties": {
        "response": {
            "type": "object",
            "description": "successful operation",
            "properties": {
                "headers": {
                    "type": "object",
                    "title": "headers",
                    "additionalProperties": false
                },
                "content": {
                    "type": "object",
                    "title": "content",
                    "properties": {
                        "application/xml": {
                            "type": "object",
                            "properties": {
                                "schema": {
                                    "$ref": "#model/definitions/schemas/properties/Pet"
                                },
                                "examples": {
                                    "type": "object",
                                    "title": "examples",
                                    "additionalProperties": false
                                },
                                "encoding": {
                                    "type": "object",
                                    "title": "encoding",
                                    "additionalProperties": false
                                }
                            },
                            "additionalProperties": false
                        },
                        "application/json": {
                            "type": "object",
                            "properties": {
                                "schema": {
                                    "$ref": "#model/definitions/schemas/properties/Pet"
                                },
                                "examples": {
                                    "type": "object",
                                    "title": "examples",
                                    "additionalProperties": false
                                },
                                "encoding": {
                                    "type": "object",
                                    "title": "encoding",
                                    "additionalProperties": false
                                }
                            },
                            "additionalProperties": false
                        }
                    },
                    "additionalProperties": false
                },
                "links": {
                    "type": "object",
                    "title": "links",
                    "additionalProperties": false
                }
            },
            "additionalProperties": false
        }
    },
    "additionalProperties": true
}
2.5.2.2.6.1.5 200 JSON data
{
    "response": {
        "headers": {},
        "content": {
            "application/xml": {
                "schema": {
                    "id": -85,
                    "category": "Lorem",
                    "name": "Lorem",
                    "photoUrls": [
                        "Lorem"
                    ],
                    "tags": [
                        "Lorem"
                    ],
                    "status": "sold"
                },
                "examples": {},
                "encoding": {}
            },
            "application/json": {
                "schema": {
                    "id": 87,
                    "category": "Lorem",
                    "name": "Lorem",
                    "photoUrls": [
                        "Lorem"
                    ],
                    "tags": [
                        "Lorem"
                    ],
                    "status": "sold"
                },
                "examples": {},
                "encoding": {}
            }
        },
        "links": {}
    }
}
2.5.2.2.6.2 Response 400
2.5.2.2.6.2.1 400 Tree Diagram
2.5.2.2.6.2.2 400 Properties
PropertyValue
Response400
Activatedtrue
Id
$ref
Description

Invalid ID supplied

Resources/pets/{petId}(1)
Parent requestget
Child response
Comments
extensions
[1] pattern
value
2.5.2.2.6.2.3 400 Fields
FieldTypeReqKeyDescriptionComments
responseresponsefalse

Invalid ID supplied

headersobjectfalse
contentobjectfalse
linksobjectfalse
2.5.2.2.6.2.3.1 Field response
2.5.2.2.6.2.3.1.1 response Hierarchy
Parent field: 400
Child field(s):
FieldTypeReqKeyDescriptionComments
headersobjectfalse
contentobjectfalse
linksobjectfalse
2.5.2.2.6.2.3.1.2 response properties
PropertyValue
Type response
Comments
Description

Invalid ID supplied

extensions
2.5.2.2.6.2.3.2 Field headers
2.5.2.2.6.2.3.2.1 headers properties
PropertyValue
Name headers
Technical name headers
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.5.2.2.6.2.3.3 Field content
2.5.2.2.6.2.3.3.1 content properties
PropertyValue
Name content
Technical name content
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.5.2.2.6.2.3.4 Field links
2.5.2.2.6.2.3.4.1 links properties
PropertyValue
Name links
Technical name links
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.5.2.2.6.2.4 400 JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "400",
    "description": "Invalid ID supplied",
    "properties": {
        "response": {
            "type": "object",
            "description": "Invalid ID supplied",
            "properties": {
                "headers": {
                    "type": "object",
                    "title": "headers",
                    "additionalProperties": false
                },
                "content": {
                    "type": "object",
                    "title": "content",
                    "additionalProperties": false
                },
                "links": {
                    "type": "object",
                    "title": "links",
                    "additionalProperties": false
                }
            },
            "additionalProperties": false
        }
    },
    "additionalProperties": true
}
2.5.2.2.6.2.5 400 JSON data
{
    "response": {
        "headers": {},
        "content": {},
        "links": {}
    }
}
2.5.2.2.6.3 Response 404
2.5.2.2.6.3.1 404 Tree Diagram
2.5.2.2.6.3.2 404 Properties
PropertyValue
Response404
Activatedtrue
Id
$ref
Description

Pet not found

Resources/pets/{petId}(1)
Parent requestget
Child response
Comments
extensions
[1] pattern
value
2.5.2.2.6.3.3 404 Fields
FieldTypeReqKeyDescriptionComments
responseresponsefalse

Pet not found

headersobjectfalse
contentobjectfalse
linksobjectfalse
2.5.2.2.6.3.3.1 Field response
2.5.2.2.6.3.3.1.1 response Hierarchy
Parent field: 404
Child field(s):
FieldTypeReqKeyDescriptionComments
headersobjectfalse
contentobjectfalse
linksobjectfalse
2.5.2.2.6.3.3.1.2 response properties
PropertyValue
Type response
Comments
Description

Pet not found

extensions
2.5.2.2.6.3.3.2 Field headers
2.5.2.2.6.3.3.2.1 headers properties
PropertyValue
Name headers
Technical name headers
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.5.2.2.6.3.3.3 Field content
2.5.2.2.6.3.3.3.1 content properties
PropertyValue
Name content
Technical name content
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.5.2.2.6.3.3.4 Field links
2.5.2.2.6.3.3.4.1 links properties
PropertyValue
Name links
Technical name links
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.5.2.2.6.3.4 404 JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "404",
    "description": "Pet not found",
    "properties": {
        "response": {
            "type": "object",
            "description": "Pet not found",
            "properties": {
                "headers": {
                    "type": "object",
                    "title": "headers",
                    "additionalProperties": false
                },
                "content": {
                    "type": "object",
                    "title": "content",
                    "additionalProperties": false
                },
                "links": {
                    "type": "object",
                    "title": "links",
                    "additionalProperties": false
                }
            },
            "additionalProperties": false
        }
    },
    "additionalProperties": true
}
2.5.2.2.6.3.5 404 JSON data
{
    "response": {
        "headers": {},
        "content": {},
        "links": {}
    }
}
2.5.2.3 Request post
2.5.2.3.1 post Tree Diagram
2.5.2.3.2 post Properties
PropertyValue
Request operationpost
Activatedtrue
Id
$ref
Description
Resources/pets/{petId}(1)
Parent request
Child response
Comments
tags
[1] tagpets
summaryUpdates a pet in the store with form data
externalDocs
[1] url
description
extensions
operationIdupdatePetWithForm
deprecated
security
[1] pattern {name}petstore_auth
operationwrite:petsread:pets
servers
[1] url
description
variables
extensions
extensions
[1] pattern
value
2.5.2.3.3 post Fields
FieldTypeReqKeyDescriptionComments
parametersarrayfalse
[0] petIdparameter (path)true

ID of pet that needs to be updated

schemaint64false
contentobjectfalse
examplesobjectfalse
requestBodyrequestBodyfalse
application/x-www-form-urlencodedmediafalse
schemaobjectfalse
namestringfalse

Updated name of the pet

statusstringfalse

Updated status of the pet

examplesobjectfalse
encodingobjectfalse
callbacksoperationObjectfalse
2.5.2.3.3.1 Field parameters
2.5.2.3.3.1.1 parameters Hierarchy
Parent field: post
Child field(s):
FieldTypeReqKeyDescriptionComments
[0] petIdparameter (path)true

ID of pet that needs to be updated

2.5.2.3.3.1.2 parameters properties
PropertyValue
Name parameters
Technical name parameters
Id
Type array
Title
Description
Required
Min items
Max items
Unique items
Additional items true
Comments
2.5.2.3.3.2 Field [0] petId
2.5.2.3.3.2.1 [0] petId Hierarchy
Parent field: parameters
Child field(s):
FieldTypeReqKeyDescriptionComments
schemaintegerfalse
contentobjectfalse
examplesobjectfalse
2.5.2.3.3.2.2 [0] petId properties
PropertyValue
Display name petId
Activated true
Parameter name petId
Type parameter (path)
Description

ID of pet that needs to be updated

Comments
Required true
Deprecated
Allow empty value
Style
Explode
Allow Reserved
example
extensions
2.5.2.3.3.3 Field schema
2.5.2.3.3.3.1 schema properties
PropertyValue
Name schema
Technical name
Activated true
Id
Type integer
Format int64
Title
Description
Required
Deprecated
Default
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Faker function
example (deprecated)
nullable
readOnly
xml
externalDocs
Comments
2.5.2.3.3.4 Field content
2.5.2.3.3.4.1 content properties
PropertyValue
Name content
Technical name content
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.5.2.3.3.5 Field examples
2.5.2.3.3.5.1 examples properties
PropertyValue
Name examples
Technical name examples
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.5.2.3.3.6 Field requestBody
2.5.2.3.3.6.1 requestBody Hierarchy
Parent field: post
Child field(s):
FieldTypeReqKeyDescriptionComments
application/x-www-form-urlencodedmediafalse
2.5.2.3.3.6.2 requestBody properties
PropertyValue
Name requestBody
Technical name
Comments
Type requestBody
Required
Description
extensions
2.5.2.3.3.7 Field application/x-www-form-urlencoded
2.5.2.3.3.7.1 application/x-www-form-urlencoded Hierarchy
Parent field: requestBody
Child field(s):
FieldTypeReqKeyDescriptionComments
schemaobjectfalse
examplesobjectfalse
encodingobjectfalse
2.5.2.3.3.7.2 application/x-www-form-urlencoded properties
PropertyValue
Name application/x-www-form-urlencoded
Activated true
Description
Comments
example
Type media
extensions
2.5.2.3.3.8 Field schema
2.5.2.3.3.8.1 schema Hierarchy
Parent field: application/x-www-form-urlencoded
Child field(s):
FieldTypeReqKeyDescriptionComments
namestringfalse

Updated name of the pet

statusstringfalse

Updated status of the pet

2.5.2.3.3.8.2 schema properties
PropertyValue
Name schema
Technical name
Activated true
Id
Type object
Title
Description
Required
Deprecated
Allow empty value
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
nullable
Discriminator
readOnly
writeOnly
xml
externalDocs
example (deprecated)
extensions
Comments
2.5.2.3.3.9 Field name
2.5.2.3.3.9.1 name properties
PropertyValue
Name name
Technical name
Activated true
Id
Type string
Format
Title
Description

Updated name of the pet

Required
Deprecated
Default
Min length
Max length
Pattern
Enum
Faker function
example (deprecated)
nullable
readOnly
writeOnly
xml
externalDocs
Comments
2.5.2.3.3.10 Field status
2.5.2.3.3.10.1 status properties
PropertyValue
Name status
Technical name
Activated true
Id
Type string
Format
Title
Description

Updated status of the pet

Required
Deprecated
Default
Min length
Max length
Pattern
Enum
Faker function
example (deprecated)
nullable
readOnly
writeOnly
xml
externalDocs
Comments
2.5.2.3.3.11 Field examples
2.5.2.3.3.11.1 examples properties
PropertyValue
Name examples
Technical name examples
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.5.2.3.3.12 Field encoding
2.5.2.3.3.12.1 encoding properties
PropertyValue
Name encoding
Technical name encoding
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.5.2.3.3.13 Field callbacks
2.5.2.3.3.13.1 callbacks properties
PropertyValue
Name callbacks
Technical name
Type operationObject
2.5.2.3.4 post JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "post",
    "properties": {
        "parameters": {
            "type": "array",
            "title": "parameters",
            "additionalItems": true,
            "items": {
                "type": "object",
                "description": "ID of pet that needs to be updated",
                "properties": {
                    "schema": {
                        "type": "number"
                    },
                    "content": {
                        "type": "object",
                        "title": "content",
                        "additionalProperties": false
                    },
                    "examples": {
                        "type": "object",
                        "title": "examples",
                        "additionalProperties": false
                    }
                },
                "additionalProperties": false
            }
        },
        "requestBody": {
            "type": "object",
            "properties": {
                "application/x-www-form-urlencoded": {
                    "type": "object",
                    "properties": {
                        "schema": {
                            "type": "object",
                            "properties": {
                                "name": {
                                    "type": "string",
                                    "description": "Updated name of the pet"
                                },
                                "status": {
                                    "type": "string",
                                    "description": "Updated status of the pet"
                                }
                            },
                            "additionalProperties": false
                        },
                        "examples": {
                            "type": "object",
                            "title": "examples",
                            "additionalProperties": false
                        },
                        "encoding": {
                            "type": "object",
                            "title": "encoding",
                            "additionalProperties": false
                        }
                    },
                    "additionalProperties": false
                }
            },
            "additionalProperties": false
        },
        "callbacks": {
            "type": "object",
            "additionalProperties": false
        }
    },
    "additionalProperties": true
}
2.5.2.3.5 post JSON data
{
    "parameters": [
        {
            "schema": -46,
            "content": {},
            "examples": {}
        }
    ],
    "requestBody": {
        "application/x-www-form-urlencoded": {
            "schema": {
                "name": "Lorem",
                "status": "Lorem"
            },
            "examples": {},
            "encoding": {}
        }
    },
    "callbacks": {}
}
2.5.2.3.6 post Responses:
2.5.2.3.6.1 Response 405
2.5.2.3.6.1.1 405 Tree Diagram
2.5.2.3.6.1.2 405 Properties
PropertyValue
Response405
Activatedtrue
Id
$ref
Description

Invalid input

Resources/pets/{petId}(1)
Parent requestpost
Child response
Comments
extensions
[1] pattern
value
2.5.2.3.6.1.3 405 Fields
FieldTypeReqKeyDescriptionComments
responseresponsefalse

Invalid input

headersobjectfalse
contentobjectfalse
linksobjectfalse
2.5.2.3.6.1.3.1 Field response
2.5.2.3.6.1.3.1.1 response Hierarchy
Parent field: 405
Child field(s):
FieldTypeReqKeyDescriptionComments
headersobjectfalse
contentobjectfalse
linksobjectfalse
2.5.2.3.6.1.3.1.2 response properties
PropertyValue
Type response
Comments
Description

Invalid input

extensions
2.5.2.3.6.1.3.2 Field headers
2.5.2.3.6.1.3.2.1 headers properties
PropertyValue
Name headers
Technical name headers
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.5.2.3.6.1.3.3 Field content
2.5.2.3.6.1.3.3.1 content properties
PropertyValue
Name content
Technical name content
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.5.2.3.6.1.3.4 Field links
2.5.2.3.6.1.3.4.1 links properties
PropertyValue
Name links
Technical name links
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.5.2.3.6.1.4 405 JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "405",
    "description": "Invalid input",
    "properties": {
        "response": {
            "type": "object",
            "description": "Invalid input",
            "properties": {
                "headers": {
                    "type": "object",
                    "title": "headers",
                    "additionalProperties": false
                },
                "content": {
                    "type": "object",
                    "title": "content",
                    "additionalProperties": false
                },
                "links": {
                    "type": "object",
                    "title": "links",
                    "additionalProperties": false
                }
            },
            "additionalProperties": false
        }
    },
    "additionalProperties": true
}
2.5.2.3.6.1.5 405 JSON data
{
    "response": {
        "headers": {},
        "content": {},
        "links": {}
    }
}
2.6 Resource /pets/{petId}/uploadImage
2.6.1 /pets/{petId}/uploadImage Properties
PropertyValue
Resource path/pets/{petId}/uploadImage
Activatedtrue
Description
summary
extensions
[1] pattern
value
Comments
2.6.2 /pets/{petId}/uploadImage Requests
2.6.2.1 Request post
2.6.2.1.1 post Tree Diagram
2.6.2.1.2 post Properties
PropertyValue
Request operationpost
Activatedtrue
Id
$ref
Description
Resources/pets/{petId}/uploadImage
Parent request
Child response
Comments
tags
[1] tagpets
summaryuploads an image
externalDocs
[1] url
description
extensions
operationIduploadFile
deprecated
security
[1] pattern {name}petstore_auth
operationwrite:petsread:pets
servers
[1] url
description
variables
extensions
extensions
[1] pattern
value
2.6.2.1.3 post Fields
FieldTypeReqKeyDescriptionComments
parametersarrayfalse
[0] petIdparameter (path)true

ID of pet to update

schemaint64false
contentobjectfalse
examplesobjectfalse
requestBodyrequestBodyfalse
application/octet-streammediafalse
schemabinaryfalse
examplesobjectfalse
encodingobjectfalse
callbacksoperationObjectfalse
2.6.2.1.3.1 Field parameters
2.6.2.1.3.1.1 parameters Hierarchy
Parent field: post
Child field(s):
FieldTypeReqKeyDescriptionComments
[0] petIdparameter (path)true

ID of pet to update

2.6.2.1.3.1.2 parameters properties
PropertyValue
Name parameters
Technical name parameters
Id
Type array
Title
Description
Required
Min items
Max items
Unique items
Additional items true
Comments
2.6.2.1.3.2 Field [0] petId
2.6.2.1.3.2.1 [0] petId Hierarchy
Parent field: parameters
Child field(s):
FieldTypeReqKeyDescriptionComments
schemaintegerfalse
contentobjectfalse
examplesobjectfalse
2.6.2.1.3.2.2 [0] petId properties
PropertyValue
Display name petId
Activated true
Parameter name petId
Type parameter (path)
Description

ID of pet to update

Comments
Required true
Deprecated
Allow empty value
Style
Explode
Allow Reserved
example
extensions
2.6.2.1.3.3 Field schema
2.6.2.1.3.3.1 schema properties
PropertyValue
Name schema
Technical name
Activated true
Id
Type integer
Format int64
Title
Description
Required
Deprecated
Default
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Faker function
example (deprecated)
nullable
readOnly
xml
externalDocs
Comments
2.6.2.1.3.4 Field content
2.6.2.1.3.4.1 content properties
PropertyValue
Name content
Technical name content
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.6.2.1.3.5 Field examples
2.6.2.1.3.5.1 examples properties
PropertyValue
Name examples
Technical name examples
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.6.2.1.3.6 Field requestBody
2.6.2.1.3.6.1 requestBody Hierarchy
Parent field: post
Child field(s):
FieldTypeReqKeyDescriptionComments
application/octet-streammediafalse
2.6.2.1.3.6.2 requestBody properties
PropertyValue
Name requestBody
Technical name
Comments
Type requestBody
Required
Description
extensions
2.6.2.1.3.7 Field application/octet-stream
2.6.2.1.3.7.1 application/octet-stream Hierarchy
Parent field: requestBody
Child field(s):
FieldTypeReqKeyDescriptionComments
schemastringfalse
examplesobjectfalse
encodingobjectfalse
2.6.2.1.3.7.2 application/octet-stream properties
PropertyValue
Name application/octet-stream
Activated true
Description
Comments
example
Type media
extensions
2.6.2.1.3.8 Field schema
2.6.2.1.3.8.1 schema properties
PropertyValue
Name schema
Technical name
Activated true
Id
Type string
Format binary
Title
Description
Required
Deprecated
Default
Min length
Max length
Pattern
Enum
Faker function
example (deprecated)
nullable
readOnly
writeOnly
xml
externalDocs
Comments
2.6.2.1.3.9 Field examples
2.6.2.1.3.9.1 examples properties
PropertyValue
Name examples
Technical name examples
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.6.2.1.3.10 Field encoding
2.6.2.1.3.10.1 encoding properties
PropertyValue
Name encoding
Technical name encoding
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.6.2.1.3.11 Field callbacks
2.6.2.1.3.11.1 callbacks properties
PropertyValue
Name callbacks
Technical name
Type operationObject
2.6.2.1.4 post JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "post",
    "properties": {
        "parameters": {
            "type": "array",
            "title": "parameters",
            "additionalItems": true,
            "items": {
                "type": "object",
                "description": "ID of pet to update",
                "properties": {
                    "schema": {
                        "type": "number"
                    },
                    "content": {
                        "type": "object",
                        "title": "content",
                        "additionalProperties": false
                    },
                    "examples": {
                        "type": "object",
                        "title": "examples",
                        "additionalProperties": false
                    }
                },
                "additionalProperties": false
            }
        },
        "requestBody": {
            "type": "object",
            "properties": {
                "application/octet-stream": {
                    "type": "object",
                    "properties": {
                        "schema": {
                            "type": "string",
                            "format": "binary"
                        },
                        "examples": {
                            "type": "object",
                            "title": "examples",
                            "additionalProperties": false
                        },
                        "encoding": {
                            "type": "object",
                            "title": "encoding",
                            "additionalProperties": false
                        }
                    },
                    "additionalProperties": false
                }
            },
            "additionalProperties": false
        },
        "callbacks": {
            "type": "object",
            "additionalProperties": false
        }
    },
    "additionalProperties": true
}
2.6.2.1.5 post JSON data
{
    "parameters": [
        {
            "schema": 85,
            "content": {},
            "examples": {}
        }
    ],
    "requestBody": {
        "application/octet-stream": {
            "examples": {},
            "encoding": {}
        }
    },
    "callbacks": {}
}
2.6.2.1.6 post Responses:
2.6.2.1.6.1 Response 200
2.6.2.1.6.1.1 200 Tree Diagram
2.6.2.1.6.1.2 200 Properties
PropertyValue
Response200
Activatedtrue
Id
$ref
Description

successful operation

Resources/pets/{petId}/uploadImage
Parent requestpost
Child response
Comments
extensions
[1] pattern
value
2.6.2.1.6.1.3 200 Fields
FieldTypeReqKeyDescriptionComments
responseresponsefalse

successful operation

headersobjectfalse
contentobjectfalse
application/jsonmediafalse
schemaobjectfalse
codeint32false
typestringfalse
messagestringfalse
examplesobjectfalse
encodingobjectfalse
linksobjectfalse
2.6.2.1.6.1.3.1 Field response
2.6.2.1.6.1.3.1.1 response Hierarchy
Parent field: 200
Child field(s):
FieldTypeReqKeyDescriptionComments
headersobjectfalse
contentobjectfalse
linksobjectfalse
2.6.2.1.6.1.3.1.2 response properties
PropertyValue
Type response
Comments
Description

successful operation

extensions
2.6.2.1.6.1.3.2 Field headers
2.6.2.1.6.1.3.2.1 headers properties
PropertyValue
Name headers
Technical name headers
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.6.2.1.6.1.3.3 Field content
2.6.2.1.6.1.3.3.1 content Hierarchy
Parent field: response
Child field(s):
FieldTypeReqKeyDescriptionComments
application/jsonmediafalse
2.6.2.1.6.1.3.3.2 content properties
PropertyValue
Name content
Technical name content
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.6.2.1.6.1.3.4 Field application/json
2.6.2.1.6.1.3.4.1 application/json Hierarchy
Parent field: content
Child field(s):
FieldTypeReqKeyDescriptionComments
schemareferencefalse
examplesobjectfalse
encodingobjectfalse
2.6.2.1.6.1.3.4.2 application/json properties
PropertyValue
Name application/json
Activated true
Description
Comments
example
Type media
extensions
2.6.2.1.6.1.3.5 Field schema
2.6.2.1.6.1.3.5.1 schema properties
PropertyValue
Name schema
Technical name
Activated true
Reference type model
Reference description
2.6.2.1.6.1.3.6 Field examples
2.6.2.1.6.1.3.6.1 examples properties
PropertyValue
Name examples
Technical name examples
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.6.2.1.6.1.3.7 Field encoding
2.6.2.1.6.1.3.7.1 encoding properties
PropertyValue
Name encoding
Technical name encoding
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.6.2.1.6.1.3.8 Field links
2.6.2.1.6.1.3.8.1 links properties
PropertyValue
Name links
Technical name links
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.6.2.1.6.1.4 200 JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "200",
    "description": "successful operation",
    "properties": {
        "response": {
            "type": "object",
            "description": "successful operation",
            "properties": {
                "headers": {
                    "type": "object",
                    "title": "headers",
                    "additionalProperties": false
                },
                "content": {
                    "type": "object",
                    "title": "content",
                    "properties": {
                        "application/json": {
                            "type": "object",
                            "properties": {
                                "schema": {
                                    "$ref": "#model/definitions/schemas/properties/ApiResponse"
                                },
                                "examples": {
                                    "type": "object",
                                    "title": "examples",
                                    "additionalProperties": false
                                },
                                "encoding": {
                                    "type": "object",
                                    "title": "encoding",
                                    "additionalProperties": false
                                }
                            },
                            "additionalProperties": false
                        }
                    },
                    "additionalProperties": false
                },
                "links": {
                    "type": "object",
                    "title": "links",
                    "additionalProperties": false
                }
            },
            "additionalProperties": false
        }
    },
    "additionalProperties": true
}
2.6.2.1.6.1.5 200 JSON data
{
    "response": {
        "headers": {},
        "content": {
            "application/json": {
                "schema": {
                    "code": -15,
                    "type": "Lorem",
                    "message": "Lorem"
                },
                "examples": {},
                "encoding": {}
            }
        },
        "links": {}
    }
}
2.7 Resource /stores/inventory
2.7.1 /stores/inventory Properties
PropertyValue
Resource path/stores/inventory
Activatedtrue
Description
summary
extensions
[1] pattern
value
Comments
2.7.2 /stores/inventory Requests
2.7.2.1 Request get
2.7.2.1.1 get Tree Diagram
2.7.2.1.2 get Properties
PropertyValue
Request operationget
Activatedtrue
Id
$ref
Description

Returns a map of status codes to quantities

Resources/stores/inventory
Parent request
Child response
Comments
tags
[1] tagstores
summaryReturns pet inventories by status
externalDocs
[1] url
description
extensions
operationIdgetInventory
deprecated
security
[1] pattern {name}api_key
operation
servers
[1] url
description
variables
extensions
extensions
[1] pattern
value
2.7.2.1.3 get Fields
FieldTypeReqKeyDescriptionComments
parametersarrayfalse
requestBodyrequestBodyfalse
callbacksoperationObjectfalse
2.7.2.1.3.1 Field parameters
2.7.2.1.3.1.1 parameters properties
PropertyValue
Name parameters
Technical name parameters
Id
Type array
Title
Description
Required
Min items
Max items
Unique items
Additional items true
Comments
2.7.2.1.3.2 Field requestBody
2.7.2.1.3.2.1 requestBody properties
PropertyValue
Name requestBody
Technical name
Comments
Type requestBody
Required
Description
extensions
2.7.2.1.3.3 Field callbacks
2.7.2.1.3.3.1 callbacks properties
PropertyValue
Name callbacks
Technical name
Type operationObject
2.7.2.1.4 get JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "get",
    "description": "Returns a map of status codes to quantities",
    "properties": {
        "parameters": {
            "type": "array",
            "title": "parameters",
            "additionalItems": true
        },
        "requestBody": {
            "type": "object",
            "additionalProperties": false
        },
        "callbacks": {
            "type": "object",
            "additionalProperties": false
        }
    },
    "additionalProperties": true
}
2.7.2.1.5 get JSON data
{
    "parameters": [],
    "requestBody": {},
    "callbacks": {}
}
2.7.2.1.6 get Responses:
2.7.2.1.6.1 Response 200
2.7.2.1.6.1.1 200 Tree Diagram
2.7.2.1.6.1.2 200 Properties
PropertyValue
Response200
Activatedtrue
Id
$ref
Description

successful operation

Resources/stores/inventory
Parent requestget
Child response
Comments
extensions
[1] pattern
value
2.7.2.1.6.1.3 200 Fields
FieldTypeReqKeyDescriptionComments
responseresponsefalse

successful operation

headersobjectfalse
contentobjectfalse
application/jsonmediafalse
schemaobjectfalse
examplesobjectfalse
encodingobjectfalse
linksobjectfalse
2.7.2.1.6.1.3.1 Field response
2.7.2.1.6.1.3.1.1 response Hierarchy
Parent field: 200
Child field(s):
FieldTypeReqKeyDescriptionComments
headersobjectfalse
contentobjectfalse
linksobjectfalse
2.7.2.1.6.1.3.1.2 response properties
PropertyValue
Type response
Comments
Description

successful operation

extensions
2.7.2.1.6.1.3.2 Field headers
2.7.2.1.6.1.3.2.1 headers properties
PropertyValue
Name headers
Technical name headers
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.7.2.1.6.1.3.3 Field content
2.7.2.1.6.1.3.3.1 content Hierarchy
Parent field: response
Child field(s):
FieldTypeReqKeyDescriptionComments
application/jsonmediafalse
2.7.2.1.6.1.3.3.2 content properties
PropertyValue
Name content
Technical name content
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.7.2.1.6.1.3.4 Field application/json
2.7.2.1.6.1.3.4.1 application/json Hierarchy
Parent field: content
Child field(s):
FieldTypeReqKeyDescriptionComments
schemaobjectfalse
examplesobjectfalse
encodingobjectfalse
2.7.2.1.6.1.3.4.2 application/json properties
PropertyValue
Name application/json
Activated true
Description
Comments
example
Type media
extensions
2.7.2.1.6.1.3.5 Field schema
2.7.2.1.6.1.3.5.1 schema properties
PropertyValue
Name schema
Technical name
Activated true
Id
Type object
Title
Description
Required
Deprecated
Allow empty value
Min Properties
Max Properties
AdditionalProp Control Object
AdditionalProp Type integer
AdditionalProp Format int32
nullable
Discriminator
readOnly
writeOnly
xml
externalDocs
example (deprecated)
extensions
Comments
2.7.2.1.6.1.3.6 Field examples
2.7.2.1.6.1.3.6.1 examples properties
PropertyValue
Name examples
Technical name examples
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.7.2.1.6.1.3.7 Field encoding
2.7.2.1.6.1.3.7.1 encoding properties
PropertyValue
Name encoding
Technical name encoding
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.7.2.1.6.1.3.8 Field links
2.7.2.1.6.1.3.8.1 links properties
PropertyValue
Name links
Technical name links
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.7.2.1.6.1.4 200 JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "200",
    "description": "successful operation",
    "properties": {
        "response": {
            "type": "object",
            "description": "successful operation",
            "properties": {
                "headers": {
                    "type": "object",
                    "title": "headers",
                    "additionalProperties": false
                },
                "content": {
                    "type": "object",
                    "title": "content",
                    "properties": {
                        "application/json": {
                            "type": "object",
                            "properties": {
                                "schema": {
                                    "type": "object",
                                    "additionalProperties": {
                                        "type": "integer",
                                        "format": "int32"
                                    }
                                },
                                "examples": {
                                    "type": "object",
                                    "title": "examples",
                                    "additionalProperties": false
                                },
                                "encoding": {
                                    "type": "object",
                                    "title": "encoding",
                                    "additionalProperties": false
                                }
                            },
                            "additionalProperties": false
                        }
                    },
                    "additionalProperties": false
                },
                "links": {
                    "type": "object",
                    "title": "links",
                    "additionalProperties": false
                }
            },
            "additionalProperties": false
        }
    },
    "additionalProperties": true
}
2.7.2.1.6.1.5 200 JSON data
{
    "response": {
        "headers": {},
        "content": {
            "application/json": {
                "schema": {},
                "examples": {},
                "encoding": {}
            }
        },
        "links": {}
    }
}
2.8 Resource /stores/orders
2.8.1 /stores/orders Properties
PropertyValue
Resource path/stores/orders
Activatedtrue
Description
summary
extensions
[1] pattern
value
Comments
2.8.2 /stores/orders Requests
2.8.2.1 Request post
2.8.2.1.1 post Tree Diagram
2.8.2.1.2 post Properties
PropertyValue
Request operationpost
Activatedtrue
Id
$ref
Description
Resources/stores/orders
Parent request
Child response
Comments
tags
[1] tagstores
summaryPlace an order for a pet
externalDocs
[1] url
description
extensions
operationIdplaceOrder
deprecated
security
[1] pattern {name}
operation
servers
[1] url
description
variables
extensions
extensions
[1] pattern
value
2.8.2.1.3 post Fields
FieldTypeReqKeyDescriptionComments
parametersarrayfalse
requestBodyrequestBodytrue

order placed for purchasing the pet

application/jsonmediafalse
schemaobjectfalse
idint64false
petIdint64false
quantityint32false
shipDatedate-timefalse
statusstringfalse

Order Status

completebooleanfalse
examplesobjectfalse
encodingobjectfalse
callbacksoperationObjectfalse
2.8.2.1.3.1 Field parameters
2.8.2.1.3.1.1 parameters properties
PropertyValue
Name parameters
Technical name parameters
Id
Type array
Title
Description
Required
Min items
Max items
Unique items
Additional items true
Comments
2.8.2.1.3.2 Field requestBody
2.8.2.1.3.2.1 requestBody Hierarchy
Parent field: post
Child field(s):
FieldTypeReqKeyDescriptionComments
application/jsonmediafalse
2.8.2.1.3.2.2 requestBody properties
PropertyValue
Name requestBody
Technical name
Comments
Type requestBody
Required true
Description

order placed for purchasing the pet

extensions
2.8.2.1.3.3 Field application/json
2.8.2.1.3.3.1 application/json Hierarchy
Parent field: requestBody
Child field(s):
FieldTypeReqKeyDescriptionComments
schemareferencefalse
examplesobjectfalse
encodingobjectfalse
2.8.2.1.3.3.2 application/json properties
PropertyValue
Name application/json
Activated true
Description
Comments
example
Type media
extensions
2.8.2.1.3.4 Field schema
2.8.2.1.3.4.1 schema properties
PropertyValue
Name schema
Technical name
Activated true
Reference type model
Reference description
2.8.2.1.3.5 Field examples
2.8.2.1.3.5.1 examples properties
PropertyValue
Name examples
Technical name examples
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.8.2.1.3.6 Field encoding
2.8.2.1.3.6.1 encoding properties
PropertyValue
Name encoding
Technical name encoding
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.8.2.1.3.7 Field callbacks
2.8.2.1.3.7.1 callbacks properties
PropertyValue
Name callbacks
Technical name
Type operationObject
2.8.2.1.4 post JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "post",
    "properties": {
        "parameters": {
            "type": "array",
            "title": "parameters",
            "additionalItems": true
        },
        "requestBody": {
            "type": "object",
            "description": "order placed for purchasing the pet",
            "properties": {
                "application/json": {
                    "type": "object",
                    "properties": {
                        "schema": {
                            "$ref": "#model/definitions/schemas/properties/Order"
                        },
                        "examples": {
                            "type": "object",
                            "title": "examples",
                            "additionalProperties": false
                        },
                        "encoding": {
                            "type": "object",
                            "title": "encoding",
                            "additionalProperties": false
                        }
                    },
                    "additionalProperties": false
                }
            },
            "additionalProperties": false
        },
        "callbacks": {
            "type": "object",
            "additionalProperties": false
        }
    },
    "additionalProperties": true,
    "required": [
        "requestBody"
    ]
}
2.8.2.1.5 post JSON data
{
    "parameters": [],
    "requestBody": {
        "application/json": {
            "schema": {
                "id": 18,
                "petId": 26,
                "quantity": 72,
                "shipDate": "2011-06-14T04:12:36.123Z",
                "status": "delivered",
                "complete": false
            },
            "examples": {},
            "encoding": {}
        }
    },
    "callbacks": {}
}
2.8.2.1.6 post Responses:
2.8.2.1.6.1 Response 200
2.8.2.1.6.1.1 200 Tree Diagram
2.8.2.1.6.1.2 200 Properties
PropertyValue
Response200
Activatedtrue
Id
$ref
Description

successful operation

Resources/stores/orders
Parent requestpost
Child response
Comments
extensions
[1] pattern
value
2.8.2.1.6.1.3 200 Fields
FieldTypeReqKeyDescriptionComments
responseresponsefalse

successful operation

headersobjectfalse
contentobjectfalse
application/xmlmediafalse
schemaobjectfalse
idint64false
petIdint64false
quantityint32false
shipDatedate-timefalse
statusstringfalse

Order Status

completebooleanfalse
examplesobjectfalse
encodingobjectfalse
application/jsonmediafalse
schemaobjectfalse
idint64false
petIdint64false
quantityint32false
shipDatedate-timefalse
statusstringfalse

Order Status

completebooleanfalse
examplesobjectfalse
encodingobjectfalse
linksobjectfalse
2.8.2.1.6.1.3.1 Field response
2.8.2.1.6.1.3.1.1 response Hierarchy
Parent field: 200
Child field(s):
FieldTypeReqKeyDescriptionComments
headersobjectfalse
contentobjectfalse
linksobjectfalse
2.8.2.1.6.1.3.1.2 response properties
PropertyValue
Type response
Comments
Description

successful operation

extensions
2.8.2.1.6.1.3.2 Field headers
2.8.2.1.6.1.3.2.1 headers properties
PropertyValue
Name headers
Technical name headers
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.8.2.1.6.1.3.3 Field content
2.8.2.1.6.1.3.3.1 content Hierarchy
Parent field: response
Child field(s):
FieldTypeReqKeyDescriptionComments
application/xmlmediafalse
application/jsonmediafalse
2.8.2.1.6.1.3.3.2 content properties
PropertyValue
Name content
Technical name content
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.8.2.1.6.1.3.4 Field application/xml
2.8.2.1.6.1.3.4.1 application/xml Hierarchy
Parent field: content
Child field(s):
FieldTypeReqKeyDescriptionComments
schemareferencefalse
examplesobjectfalse
encodingobjectfalse
2.8.2.1.6.1.3.4.2 application/xml properties
PropertyValue
Name application/xml
Activated true
Description
Comments
example
Type media
extensions
2.8.2.1.6.1.3.5 Field schema
2.8.2.1.6.1.3.5.1 schema properties
PropertyValue
Name schema
Technical name
Activated true
Reference type model
Reference description
2.8.2.1.6.1.3.6 Field examples
2.8.2.1.6.1.3.6.1 examples properties
PropertyValue
Name examples
Technical name examples
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.8.2.1.6.1.3.7 Field encoding
2.8.2.1.6.1.3.7.1 encoding properties
PropertyValue
Name encoding
Technical name encoding
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.8.2.1.6.1.3.8 Field application/json
2.8.2.1.6.1.3.8.1 application/json Hierarchy
Parent field: content
Child field(s):
FieldTypeReqKeyDescriptionComments
schemareferencefalse
examplesobjectfalse
encodingobjectfalse
2.8.2.1.6.1.3.8.2 application/json properties
PropertyValue
Name application/json
Activated true
Description
Comments
example
Type media
extensions
2.8.2.1.6.1.3.9 Field schema
2.8.2.1.6.1.3.9.1 schema properties
PropertyValue
Name schema
Technical name
Activated true
Reference type model
Reference description
2.8.2.1.6.1.3.10 Field examples
2.8.2.1.6.1.3.10.1 examples properties
PropertyValue
Name examples
Technical name examples
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.8.2.1.6.1.3.11 Field encoding
2.8.2.1.6.1.3.11.1 encoding properties
PropertyValue
Name encoding
Technical name encoding
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.8.2.1.6.1.3.12 Field links
2.8.2.1.6.1.3.12.1 links properties
PropertyValue
Name links
Technical name links
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.8.2.1.6.1.4 200 JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "200",
    "description": "successful operation",
    "properties": {
        "response": {
            "type": "object",
            "description": "successful operation",
            "properties": {
                "headers": {
                    "type": "object",
                    "title": "headers",
                    "additionalProperties": false
                },
                "content": {
                    "type": "object",
                    "title": "content",
                    "properties": {
                        "application/xml": {
                            "type": "object",
                            "properties": {
                                "schema": {
                                    "$ref": "#model/definitions/schemas/properties/Order"
                                },
                                "examples": {
                                    "type": "object",
                                    "title": "examples",
                                    "additionalProperties": false
                                },
                                "encoding": {
                                    "type": "object",
                                    "title": "encoding",
                                    "additionalProperties": false
                                }
                            },
                            "additionalProperties": false
                        },
                        "application/json": {
                            "type": "object",
                            "properties": {
                                "schema": {
                                    "$ref": "#model/definitions/schemas/properties/Order"
                                },
                                "examples": {
                                    "type": "object",
                                    "title": "examples",
                                    "additionalProperties": false
                                },
                                "encoding": {
                                    "type": "object",
                                    "title": "encoding",
                                    "additionalProperties": false
                                }
                            },
                            "additionalProperties": false
                        }
                    },
                    "additionalProperties": false
                },
                "links": {
                    "type": "object",
                    "title": "links",
                    "additionalProperties": false
                }
            },
            "additionalProperties": false
        }
    },
    "additionalProperties": true
}
2.8.2.1.6.1.5 200 JSON data
{
    "response": {
        "headers": {},
        "content": {
            "application/xml": {
                "schema": {
                    "id": 73,
                    "petId": 77,
                    "quantity": 59,
                    "shipDate": "2011-06-14T04:12:36.123Z",
                    "status": "delivered",
                    "complete": false
                },
                "examples": {},
                "encoding": {}
            },
            "application/json": {
                "schema": {
                    "id": 16,
                    "petId": -73,
                    "quantity": -83,
                    "shipDate": "2011-06-14T04:12:36.123Z",
                    "status": "delivered",
                    "complete": false
                },
                "examples": {},
                "encoding": {}
            }
        },
        "links": {}
    }
}
2.8.2.1.6.2 Response 400
2.8.2.1.6.2.1 400 Tree Diagram
2.8.2.1.6.2.2 400 Properties
PropertyValue
Response400
Activatedtrue
Id
$ref
Description

Invalid Order

Resources/stores/orders
Parent requestpost
Child response
Comments
extensions
[1] pattern
value
2.8.2.1.6.2.3 400 Fields
FieldTypeReqKeyDescriptionComments
responseresponsefalse

Invalid Order

headersobjectfalse
contentobjectfalse
linksobjectfalse
2.8.2.1.6.2.3.1 Field response
2.8.2.1.6.2.3.1.1 response Hierarchy
Parent field: 400
Child field(s):
FieldTypeReqKeyDescriptionComments
headersobjectfalse
contentobjectfalse
linksobjectfalse
2.8.2.1.6.2.3.1.2 response properties
PropertyValue
Type response
Comments
Description

Invalid Order

extensions
2.8.2.1.6.2.3.2 Field headers
2.8.2.1.6.2.3.2.1 headers properties
PropertyValue
Name headers
Technical name headers
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.8.2.1.6.2.3.3 Field content
2.8.2.1.6.2.3.3.1 content properties
PropertyValue
Name content
Technical name content
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.8.2.1.6.2.3.4 Field links
2.8.2.1.6.2.3.4.1 links properties
PropertyValue
Name links
Technical name links
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.8.2.1.6.2.4 400 JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "400",
    "description": "Invalid Order",
    "properties": {
        "response": {
            "type": "object",
            "description": "Invalid Order",
            "properties": {
                "headers": {
                    "type": "object",
                    "title": "headers",
                    "additionalProperties": false
                },
                "content": {
                    "type": "object",
                    "title": "content",
                    "additionalProperties": false
                },
                "links": {
                    "type": "object",
                    "title": "links",
                    "additionalProperties": false
                }
            },
            "additionalProperties": false
        }
    },
    "additionalProperties": true
}
2.8.2.1.6.2.5 400 JSON data
{
    "response": {
        "headers": {},
        "content": {},
        "links": {}
    }
}
2.9 Resource /stores/orders/{orderId}
2.9.1 /stores/orders/{orderId} Properties
PropertyValue
Resource path/stores/orders/{orderId}
Activatedtrue
Description
summary
extensions
[1] pattern
value
Comments
2.9.2 /stores/orders/{orderId} Requests
2.9.2.1 Request delete
2.9.2.1.1 delete Tree Diagram
2.9.2.1.2 delete Properties
PropertyValue
Request operationdelete
Activatedtrue
Id
$ref
Description

For valid response try integer IDs with positive integer value. Negative or non-integer values will generate API errors

Resources/stores/orders/{orderId}
Parent request
Child response
Comments
tags
[1] tagstores
summaryDelete purchase order by ID
externalDocs
[1] url
description
extensions
operationIddeleteOrder
deprecated
security
[1] pattern {name}
operation
servers
[1] url
description
variables
extensions
extensions
[1] pattern
value
2.9.2.1.3 delete Fields
FieldTypeReqKeyDescriptionComments
parametersarrayfalse
[0] orderIdparameter (path)true

ID of the order that needs to be deleted

schemaint64false
contentobjectfalse
examplesobjectfalse
requestBodyrequestBodyfalse
callbacksoperationObjectfalse
2.9.2.1.3.1 Field parameters
2.9.2.1.3.1.1 parameters Hierarchy
Parent field: delete
Child field(s):
FieldTypeReqKeyDescriptionComments
[0] orderIdparameter (path)true

ID of the order that needs to be deleted

2.9.2.1.3.1.2 parameters properties
PropertyValue
Name parameters
Technical name parameters
Id
Type array
Title
Description
Required
Min items
Max items
Unique items
Additional items true
Comments
2.9.2.1.3.2 Field [0] orderId
2.9.2.1.3.2.1 [0] orderId Hierarchy
Parent field: parameters
Child field(s):
FieldTypeReqKeyDescriptionComments
schemaintegerfalse
contentobjectfalse
examplesobjectfalse
2.9.2.1.3.2.2 [0] orderId properties
PropertyValue
Display name orderId
Activated true
Parameter name orderId
Type parameter (path)
Description

ID of the order that needs to be deleted

Comments
Required true
Deprecated
Allow empty value
Style
Explode
Allow Reserved
example
extensions
2.9.2.1.3.3 Field schema
2.9.2.1.3.3.1 schema properties
PropertyValue
Name schema
Technical name
Activated true
Id
Type integer
Format int64
Title
Description
Required
Deprecated
Default
Min value 1
Excl min
Max value
Excl max
Multiple of
Enum
Faker function
example (deprecated)
nullable
readOnly
xml
externalDocs
Comments
2.9.2.1.3.4 Field content
2.9.2.1.3.4.1 content properties
PropertyValue
Name content
Technical name content
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.9.2.1.3.5 Field examples
2.9.2.1.3.5.1 examples properties
PropertyValue
Name examples
Technical name examples
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.9.2.1.3.6 Field requestBody
2.9.2.1.3.6.1 requestBody properties
PropertyValue
Name requestBody
Technical name
Comments
Type requestBody
Required
Description
extensions
2.9.2.1.3.7 Field callbacks
2.9.2.1.3.7.1 callbacks properties
PropertyValue
Name callbacks
Technical name
Type operationObject
2.9.2.1.4 delete JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "delete",
    "description": "For valid response try integer IDs with positive integer value. Negative or non-integer values will generate API errors",
    "properties": {
        "parameters": {
            "type": "array",
            "title": "parameters",
            "additionalItems": true,
            "items": {
                "type": "object",
                "description": "ID of the order that needs to be deleted",
                "properties": {
                    "schema": {
                        "type": "number",
                        "minimum": 1
                    },
                    "content": {
                        "type": "object",
                        "title": "content",
                        "additionalProperties": false
                    },
                    "examples": {
                        "type": "object",
                        "title": "examples",
                        "additionalProperties": false
                    }
                },
                "additionalProperties": false
            }
        },
        "requestBody": {
            "type": "object",
            "additionalProperties": false
        },
        "callbacks": {
            "type": "object",
            "additionalProperties": false
        }
    },
    "additionalProperties": true
}
2.9.2.1.5 delete JSON data
{
    "parameters": [
        {
            "schema": 45,
            "content": {},
            "examples": {}
        }
    ],
    "requestBody": {},
    "callbacks": {}
}
2.9.2.1.6 delete Responses:
2.9.2.1.6.1 Response 400
2.9.2.1.6.1.1 400 Tree Diagram
2.9.2.1.6.1.2 400 Properties
PropertyValue
Response400
Activatedtrue
Id
$ref
Description

Invalid ID supplied

Resources/stores/orders/{orderId}
Parent requestdelete
Child response
Comments
extensions
[1] pattern
value
2.9.2.1.6.1.3 400 Fields
FieldTypeReqKeyDescriptionComments
responseresponsefalse

Invalid ID supplied

headersobjectfalse
contentobjectfalse
linksobjectfalse
2.9.2.1.6.1.3.1 Field response
2.9.2.1.6.1.3.1.1 response Hierarchy
Parent field: 400
Child field(s):
FieldTypeReqKeyDescriptionComments
headersobjectfalse
contentobjectfalse
linksobjectfalse
2.9.2.1.6.1.3.1.2 response properties
PropertyValue
Type response
Comments
Description

Invalid ID supplied

extensions
2.9.2.1.6.1.3.2 Field headers
2.9.2.1.6.1.3.2.1 headers properties
PropertyValue
Name headers
Technical name headers
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.9.2.1.6.1.3.3 Field content
2.9.2.1.6.1.3.3.1 content properties
PropertyValue
Name content
Technical name content
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.9.2.1.6.1.3.4 Field links
2.9.2.1.6.1.3.4.1 links properties
PropertyValue
Name links
Technical name links
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.9.2.1.6.1.4 400 JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "400",
    "description": "Invalid ID supplied",
    "properties": {
        "response": {
            "type": "object",
            "description": "Invalid ID supplied",
            "properties": {
                "headers": {
                    "type": "object",
                    "title": "headers",
                    "additionalProperties": false
                },
                "content": {
                    "type": "object",
                    "title": "content",
                    "additionalProperties": false
                },
                "links": {
                    "type": "object",
                    "title": "links",
                    "additionalProperties": false
                }
            },
            "additionalProperties": false
        }
    },
    "additionalProperties": true
}
2.9.2.1.6.1.5 400 JSON data
{
    "response": {
        "headers": {},
        "content": {},
        "links": {}
    }
}
2.9.2.1.6.2 Response 404
2.9.2.1.6.2.1 404 Tree Diagram
2.9.2.1.6.2.2 404 Properties
PropertyValue
Response404
Activatedtrue
Id
$ref
Description

Order not found

Resources/stores/orders/{orderId}
Parent requestdelete
Child response
Comments
extensions
[1] pattern
value
2.9.2.1.6.2.3 404 Fields
FieldTypeReqKeyDescriptionComments
responseresponsefalse

Order not found

headersobjectfalse
contentobjectfalse
linksobjectfalse
2.9.2.1.6.2.3.1 Field response
2.9.2.1.6.2.3.1.1 response Hierarchy
Parent field: 404
Child field(s):
FieldTypeReqKeyDescriptionComments
headersobjectfalse
contentobjectfalse
linksobjectfalse
2.9.2.1.6.2.3.1.2 response properties
PropertyValue
Type response
Comments
Description

Order not found

extensions
2.9.2.1.6.2.3.2 Field headers
2.9.2.1.6.2.3.2.1 headers properties
PropertyValue
Name headers
Technical name headers
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.9.2.1.6.2.3.3 Field content
2.9.2.1.6.2.3.3.1 content properties
PropertyValue
Name content
Technical name content
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.9.2.1.6.2.3.4 Field links
2.9.2.1.6.2.3.4.1 links properties
PropertyValue
Name links
Technical name links
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.9.2.1.6.2.4 404 JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "404",
    "description": "Order not found",
    "properties": {
        "response": {
            "type": "object",
            "description": "Order not found",
            "properties": {
                "headers": {
                    "type": "object",
                    "title": "headers",
                    "additionalProperties": false
                },
                "content": {
                    "type": "object",
                    "title": "content",
                    "additionalProperties": false
                },
                "links": {
                    "type": "object",
                    "title": "links",
                    "additionalProperties": false
                }
            },
            "additionalProperties": false
        }
    },
    "additionalProperties": true
}
2.9.2.1.6.2.5 404 JSON data
{
    "response": {
        "headers": {},
        "content": {},
        "links": {}
    }
}
2.9.2.2 Request get
2.9.2.2.1 get Tree Diagram
2.9.2.2.2 get Properties
PropertyValue
Request operationget
Activatedtrue
Id
$ref
Description

For valid response try integer IDs with value >= 1 and <= 10. Other values will generated exceptions

Resources/stores/orders/{orderId}
Parent request
Child response
Comments
tags
[1] tagstores
summaryFind purchase order by ID
externalDocs
[1] url
description
extensions
operationIdgetOrderById
deprecated
security
[1] pattern {name}
operation
servers
[1] url
description
variables
extensions
extensions
[1] pattern
value
2.9.2.2.3 get Fields
FieldTypeReqKeyDescriptionComments
parametersarrayfalse
[0] orderIdparameter (path)true

ID of pet that needs to be fetched

schemaint64false
contentobjectfalse
examplesobjectfalse
requestBodyrequestBodyfalse
callbacksoperationObjectfalse
2.9.2.2.3.1 Field parameters
2.9.2.2.3.1.1 parameters Hierarchy
Parent field: get
Child field(s):
FieldTypeReqKeyDescriptionComments
[0] orderIdparameter (path)true

ID of pet that needs to be fetched

2.9.2.2.3.1.2 parameters properties
PropertyValue
Name parameters
Technical name parameters
Id
Type array
Title
Description
Required
Min items
Max items
Unique items
Additional items true
Comments
2.9.2.2.3.2 Field [0] orderId
2.9.2.2.3.2.1 [0] orderId Hierarchy
Parent field: parameters
Child field(s):
FieldTypeReqKeyDescriptionComments
schemaintegerfalse
contentobjectfalse
examplesobjectfalse
2.9.2.2.3.2.2 [0] orderId properties
PropertyValue
Display name orderId
Activated true
Parameter name orderId
Type parameter (path)
Description

ID of pet that needs to be fetched

Comments
Required true
Deprecated
Allow empty value
Style
Explode
Allow Reserved
example
extensions
2.9.2.2.3.3 Field schema
2.9.2.2.3.3.1 schema properties
PropertyValue
Name schema
Technical name
Activated true
Id
Type integer
Format int64
Title
Description
Required
Deprecated
Default
Min value 1
Excl min
Max value 10
Excl max
Multiple of
Enum
Faker function
example (deprecated)
nullable
readOnly
xml
externalDocs
Comments
2.9.2.2.3.4 Field content
2.9.2.2.3.4.1 content properties
PropertyValue
Name content
Technical name content
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.9.2.2.3.5 Field examples
2.9.2.2.3.5.1 examples properties
PropertyValue
Name examples
Technical name examples
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.9.2.2.3.6 Field requestBody
2.9.2.2.3.6.1 requestBody properties
PropertyValue
Name requestBody
Technical name
Comments
Type requestBody
Required
Description
extensions
2.9.2.2.3.7 Field callbacks
2.9.2.2.3.7.1 callbacks properties
PropertyValue
Name callbacks
Technical name
Type operationObject
2.9.2.2.4 get JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "get",
    "description": "For valid response try integer IDs with value >= 1 and <= 10. Other values will generated exceptions",
    "properties": {
        "parameters": {
            "type": "array",
            "title": "parameters",
            "additionalItems": true,
            "items": {
                "type": "object",
                "description": "ID of pet that needs to be fetched",
                "properties": {
                    "schema": {
                        "type": "number",
                        "maximum": 10,
                        "minimum": 1
                    },
                    "content": {
                        "type": "object",
                        "title": "content",
                        "additionalProperties": false
                    },
                    "examples": {
                        "type": "object",
                        "title": "examples",
                        "additionalProperties": false
                    }
                },
                "additionalProperties": false
            }
        },
        "requestBody": {
            "type": "object",
            "additionalProperties": false
        },
        "callbacks": {
            "type": "object",
            "additionalProperties": false
        }
    },
    "additionalProperties": true
}
2.9.2.2.5 get JSON data
{
    "parameters": [
        {
            "schema": 7,
            "content": {},
            "examples": {}
        }
    ],
    "requestBody": {},
    "callbacks": {}
}
2.9.2.2.6 get Responses:
2.9.2.2.6.1 Response 200
2.9.2.2.6.1.1 200 Tree Diagram
2.9.2.2.6.1.2 200 Properties
PropertyValue
Response200
Activatedtrue
Id
$ref
Description

successful operation

Resources/stores/orders/{orderId}
Parent requestget
Child response
Comments
extensions
[1] pattern
value
2.9.2.2.6.1.3 200 Fields
FieldTypeReqKeyDescriptionComments
responseresponsefalse

successful operation

headersobjectfalse
contentobjectfalse
application/xmlmediafalse
schemaobjectfalse
idint64false
petIdint64false
quantityint32false
shipDatedate-timefalse
statusstringfalse

Order Status

completebooleanfalse
examplesobjectfalse
encodingobjectfalse
application/jsonmediafalse
schemaobjectfalse
idint64false
petIdint64false
quantityint32false
shipDatedate-timefalse
statusstringfalse

Order Status

completebooleanfalse
examplesobjectfalse
encodingobjectfalse
linksobjectfalse
2.9.2.2.6.1.3.1 Field response
2.9.2.2.6.1.3.1.1 response Hierarchy
Parent field: 200
Child field(s):
FieldTypeReqKeyDescriptionComments
headersobjectfalse
contentobjectfalse
linksobjectfalse
2.9.2.2.6.1.3.1.2 response properties
PropertyValue
Type response
Comments
Description

successful operation

extensions
2.9.2.2.6.1.3.2 Field headers
2.9.2.2.6.1.3.2.1 headers properties
PropertyValue
Name headers
Technical name headers
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.9.2.2.6.1.3.3 Field content
2.9.2.2.6.1.3.3.1 content Hierarchy
Parent field: response
Child field(s):
FieldTypeReqKeyDescriptionComments
application/xmlmediafalse
application/jsonmediafalse
2.9.2.2.6.1.3.3.2 content properties
PropertyValue
Name content
Technical name content
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.9.2.2.6.1.3.4 Field application/xml
2.9.2.2.6.1.3.4.1 application/xml Hierarchy
Parent field: content
Child field(s):
FieldTypeReqKeyDescriptionComments
schemareferencefalse
examplesobjectfalse
encodingobjectfalse
2.9.2.2.6.1.3.4.2 application/xml properties
PropertyValue
Name application/xml
Activated true
Description
Comments
example
Type media
extensions
2.9.2.2.6.1.3.5 Field schema
2.9.2.2.6.1.3.5.1 schema properties
PropertyValue
Name schema
Technical name
Activated true
Reference type model
Reference description
2.9.2.2.6.1.3.6 Field examples
2.9.2.2.6.1.3.6.1 examples properties
PropertyValue
Name examples
Technical name examples
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.9.2.2.6.1.3.7 Field encoding
2.9.2.2.6.1.3.7.1 encoding properties
PropertyValue
Name encoding
Technical name encoding
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.9.2.2.6.1.3.8 Field application/json
2.9.2.2.6.1.3.8.1 application/json Hierarchy
Parent field: content
Child field(s):
FieldTypeReqKeyDescriptionComments
schemareferencefalse
examplesobjectfalse
encodingobjectfalse
2.9.2.2.6.1.3.8.2 application/json properties
PropertyValue
Name application/json
Activated true
Description
Comments
example
Type media
extensions
2.9.2.2.6.1.3.9 Field schema
2.9.2.2.6.1.3.9.1 schema properties
PropertyValue
Name schema
Technical name
Activated true
Reference type model
Reference description
2.9.2.2.6.1.3.10 Field examples
2.9.2.2.6.1.3.10.1 examples properties
PropertyValue
Name examples
Technical name examples
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.9.2.2.6.1.3.11 Field encoding
2.9.2.2.6.1.3.11.1 encoding properties
PropertyValue
Name encoding
Technical name encoding
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.9.2.2.6.1.3.12 Field links
2.9.2.2.6.1.3.12.1 links properties
PropertyValue
Name links
Technical name links
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.9.2.2.6.1.4 200 JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "200",
    "description": "successful operation",
    "properties": {
        "response": {
            "type": "object",
            "description": "successful operation",
            "properties": {
                "headers": {
                    "type": "object",
                    "title": "headers",
                    "additionalProperties": false
                },
                "content": {
                    "type": "object",
                    "title": "content",
                    "properties": {
                        "application/xml": {
                            "type": "object",
                            "properties": {
                                "schema": {
                                    "$ref": "#model/definitions/schemas/properties/Order"
                                },
                                "examples": {
                                    "type": "object",
                                    "title": "examples",
                                    "additionalProperties": false
                                },
                                "encoding": {
                                    "type": "object",
                                    "title": "encoding",
                                    "additionalProperties": false
                                }
                            },
                            "additionalProperties": false
                        },
                        "application/json": {
                            "type": "object",
                            "properties": {
                                "schema": {
                                    "$ref": "#model/definitions/schemas/properties/Order"
                                },
                                "examples": {
                                    "type": "object",
                                    "title": "examples",
                                    "additionalProperties": false
                                },
                                "encoding": {
                                    "type": "object",
                                    "title": "encoding",
                                    "additionalProperties": false
                                }
                            },
                            "additionalProperties": false
                        }
                    },
                    "additionalProperties": false
                },
                "links": {
                    "type": "object",
                    "title": "links",
                    "additionalProperties": false
                }
            },
            "additionalProperties": false
        }
    },
    "additionalProperties": true
}
2.9.2.2.6.1.5 200 JSON data
{
    "response": {
        "headers": {},
        "content": {
            "application/xml": {
                "schema": {
                    "id": -88,
                    "petId": 36,
                    "quantity": 28,
                    "shipDate": "2011-06-14T04:12:36.123Z",
                    "status": "delivered",
                    "complete": false
                },
                "examples": {},
                "encoding": {}
            },
            "application/json": {
                "schema": {
                    "id": -55,
                    "petId": -29,
                    "quantity": -82,
                    "shipDate": "2011-06-14T04:12:36.123Z",
                    "status": "delivered",
                    "complete": false
                },
                "examples": {},
                "encoding": {}
            }
        },
        "links": {}
    }
}
2.9.2.2.6.2 Response 400
2.9.2.2.6.2.1 400 Tree Diagram
2.9.2.2.6.2.2 400 Properties
PropertyValue
Response400
Activatedtrue
Id
$ref
Description

Invalid ID supplied

Resources/stores/orders/{orderId}
Parent requestget
Child response
Comments
extensions
[1] pattern
value
2.9.2.2.6.2.3 400 Fields
FieldTypeReqKeyDescriptionComments
responseresponsefalse

Invalid ID supplied

headersobjectfalse
contentobjectfalse
linksobjectfalse
2.9.2.2.6.2.3.1 Field response
2.9.2.2.6.2.3.1.1 response Hierarchy
Parent field: 400
Child field(s):
FieldTypeReqKeyDescriptionComments
headersobjectfalse
contentobjectfalse
linksobjectfalse
2.9.2.2.6.2.3.1.2 response properties
PropertyValue
Type response
Comments
Description

Invalid ID supplied

extensions
2.9.2.2.6.2.3.2 Field headers
2.9.2.2.6.2.3.2.1 headers properties
PropertyValue
Name headers
Technical name headers
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.9.2.2.6.2.3.3 Field content
2.9.2.2.6.2.3.3.1 content properties
PropertyValue
Name content
Technical name content
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.9.2.2.6.2.3.4 Field links
2.9.2.2.6.2.3.4.1 links properties
PropertyValue
Name links
Technical name links
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.9.2.2.6.2.4 400 JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "400",
    "description": "Invalid ID supplied",
    "properties": {
        "response": {
            "type": "object",
            "description": "Invalid ID supplied",
            "properties": {
                "headers": {
                    "type": "object",
                    "title": "headers",
                    "additionalProperties": false
                },
                "content": {
                    "type": "object",
                    "title": "content",
                    "additionalProperties": false
                },
                "links": {
                    "type": "object",
                    "title": "links",
                    "additionalProperties": false
                }
            },
            "additionalProperties": false
        }
    },
    "additionalProperties": true
}
2.9.2.2.6.2.5 400 JSON data
{
    "response": {
        "headers": {},
        "content": {},
        "links": {}
    }
}
2.9.2.2.6.3 Response 404
2.9.2.2.6.3.1 404 Tree Diagram
2.9.2.2.6.3.2 404 Properties
PropertyValue
Response404
Activatedtrue
Id
$ref
Description

Order not found

Resources/stores/orders/{orderId}
Parent requestget
Child response
Comments
extensions
[1] pattern
value
2.9.2.2.6.3.3 404 Fields
FieldTypeReqKeyDescriptionComments
responseresponsefalse

Order not found

headersobjectfalse
contentobjectfalse
linksobjectfalse
2.9.2.2.6.3.3.1 Field response
2.9.2.2.6.3.3.1.1 response Hierarchy
Parent field: 404
Child field(s):
FieldTypeReqKeyDescriptionComments
headersobjectfalse
contentobjectfalse
linksobjectfalse
2.9.2.2.6.3.3.1.2 response properties
PropertyValue
Type response
Comments
Description

Order not found

extensions
2.9.2.2.6.3.3.2 Field headers
2.9.2.2.6.3.3.2.1 headers properties
PropertyValue
Name headers
Technical name headers
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.9.2.2.6.3.3.3 Field content
2.9.2.2.6.3.3.3.1 content properties
PropertyValue
Name content
Technical name content
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.9.2.2.6.3.3.4 Field links
2.9.2.2.6.3.3.4.1 links properties
PropertyValue
Name links
Technical name links
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.9.2.2.6.3.4 404 JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "404",
    "description": "Order not found",
    "properties": {
        "response": {
            "type": "object",
            "description": "Order not found",
            "properties": {
                "headers": {
                    "type": "object",
                    "title": "headers",
                    "additionalProperties": false
                },
                "content": {
                    "type": "object",
                    "title": "content",
                    "additionalProperties": false
                },
                "links": {
                    "type": "object",
                    "title": "links",
                    "additionalProperties": false
                }
            },
            "additionalProperties": false
        }
    },
    "additionalProperties": true
}
2.9.2.2.6.3.5 404 JSON data
{
    "response": {
        "headers": {},
        "content": {},
        "links": {}
    }
}
2.10 Resource /users
2.10.1 /users Properties
PropertyValue
Resource path/users
Activatedtrue
Description
summary
extensions
[1] pattern
value
Comments
2.10.2 /users Requests
2.10.2.1 Request post
2.10.2.1.1 post Tree Diagram
2.10.2.1.2 post Properties
PropertyValue
Request operationpost
Activatedtrue
Id
$ref
Description

This can only be done by the logged in user.

Resources/users
Parent request
Child response
Comments
tags
[1] tagusers
summaryCreate user
externalDocs
[1] url
description
extensions
operationIdcreateUser
deprecated
security
[1] pattern {name}
operation
servers
[1] url
description
variables
extensions
extensions
[1] pattern
value
2.10.2.1.3 post Fields
FieldTypeReqKeyDescriptionComments
parametersarrayfalse
requestBodyrequestBodytrue

Created user object

application/jsonmediafalse
schemaobjectfalse
idint64false
usernamestringfalse
firstNamestringfalse
lastNamestringfalse
emailstringfalse
passwordstringfalse
phonestringfalse
userStatusint32false

User Status

examplesobjectfalse
encodingobjectfalse
callbacksoperationObjectfalse
2.10.2.1.3.1 Field parameters
2.10.2.1.3.1.1 parameters properties
PropertyValue
Name parameters
Technical name parameters
Id
Type array
Title
Description
Required
Min items
Max items
Unique items
Additional items true
Comments
2.10.2.1.3.2 Field requestBody
2.10.2.1.3.2.1 requestBody Hierarchy
Parent field: post
Child field(s):
FieldTypeReqKeyDescriptionComments
application/jsonmediafalse
2.10.2.1.3.2.2 requestBody properties
PropertyValue
Name requestBody
Technical name
Comments
Type requestBody
Required true
Description

Created user object

extensions
2.10.2.1.3.3 Field application/json
2.10.2.1.3.3.1 application/json Hierarchy
Parent field: requestBody
Child field(s):
FieldTypeReqKeyDescriptionComments
schemareferencefalse
examplesobjectfalse
encodingobjectfalse
2.10.2.1.3.3.2 application/json properties
PropertyValue
Name application/json
Activated true
Description
Comments
example
Type media
extensions
2.10.2.1.3.4 Field schema
2.10.2.1.3.4.1 schema properties
PropertyValue
Name schema
Technical name
Activated true
Reference type model
Reference description
2.10.2.1.3.5 Field examples
2.10.2.1.3.5.1 examples properties
PropertyValue
Name examples
Technical name examples
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.10.2.1.3.6 Field encoding
2.10.2.1.3.6.1 encoding properties
PropertyValue
Name encoding
Technical name encoding
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.10.2.1.3.7 Field callbacks
2.10.2.1.3.7.1 callbacks properties
PropertyValue
Name callbacks
Technical name
Type operationObject
2.10.2.1.4 post JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "post",
    "description": "This can only be done by the logged in user.",
    "properties": {
        "parameters": {
            "type": "array",
            "title": "parameters",
            "additionalItems": true
        },
        "requestBody": {
            "type": "object",
            "description": "Created user object",
            "properties": {
                "application/json": {
                    "type": "object",
                    "properties": {
                        "schema": {
                            "$ref": "#model/definitions/schemas/properties/User"
                        },
                        "examples": {
                            "type": "object",
                            "title": "examples",
                            "additionalProperties": false
                        },
                        "encoding": {
                            "type": "object",
                            "title": "encoding",
                            "additionalProperties": false
                        }
                    },
                    "additionalProperties": false
                }
            },
            "additionalProperties": false
        },
        "callbacks": {
            "type": "object",
            "additionalProperties": false
        }
    },
    "additionalProperties": true,
    "required": [
        "requestBody"
    ]
}
2.10.2.1.5 post JSON data
{
    "parameters": [],
    "requestBody": {
        "application/json": {
            "schema": {
                "id": 64,
                "username": "Lorem",
                "firstName": "Lorem",
                "lastName": "Lorem",
                "email": "Lorem",
                "password": "Lorem",
                "phone": "Lorem",
                "userStatus": 61
            },
            "examples": {},
            "encoding": {}
        }
    },
    "callbacks": {}
}
2.10.2.1.6 post Responses:
2.10.2.1.6.1 Response default
2.10.2.1.6.1.1 default Tree Diagram
2.10.2.1.6.1.2 default Properties
PropertyValue
Responsedefault
Activatedtrue
Id
$ref
Description

successful operation

Resources/users
Parent requestpost
Child response
Comments
extensions
[1] pattern
value
2.10.2.1.6.1.3 default Fields
FieldTypeReqKeyDescriptionComments
responseresponsefalse

successful operation

headersobjectfalse
contentobjectfalse
linksobjectfalse
2.10.2.1.6.1.3.1 Field response
2.10.2.1.6.1.3.1.1 response Hierarchy
Parent field: default
Child field(s):
FieldTypeReqKeyDescriptionComments
headersobjectfalse
contentobjectfalse
linksobjectfalse
2.10.2.1.6.1.3.1.2 response properties
PropertyValue
Type response
Comments
Description

successful operation

extensions
2.10.2.1.6.1.3.2 Field headers
2.10.2.1.6.1.3.2.1 headers properties
PropertyValue
Name headers
Technical name headers
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.10.2.1.6.1.3.3 Field content
2.10.2.1.6.1.3.3.1 content properties
PropertyValue
Name content
Technical name content
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.10.2.1.6.1.3.4 Field links
2.10.2.1.6.1.3.4.1 links properties
PropertyValue
Name links
Technical name links
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.10.2.1.6.1.4 default JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "default",
    "description": "successful operation",
    "properties": {
        "response": {
            "type": "object",
            "description": "successful operation",
            "properties": {
                "headers": {
                    "type": "object",
                    "title": "headers",
                    "additionalProperties": false
                },
                "content": {
                    "type": "object",
                    "title": "content",
                    "additionalProperties": false
                },
                "links": {
                    "type": "object",
                    "title": "links",
                    "additionalProperties": false
                }
            },
            "additionalProperties": false
        }
    },
    "additionalProperties": true
}
2.10.2.1.6.1.5 default JSON data
{
    "response": {
        "headers": {},
        "content": {},
        "links": {}
    }
}
2.11 Resource /users/createWithArray
2.11.1 /users/createWithArray Properties
PropertyValue
Resource path/users/createWithArray
Activatedtrue
Description
summary
extensions
[1] pattern
value
Comments
2.11.2 /users/createWithArray Requests
2.11.2.1 Request post
2.11.2.1.1 post Tree Diagram
2.11.2.1.2 post Properties
PropertyValue
Request operationpost
Activatedtrue
Id
$ref
Description
Resources/users/createWithArray
Parent request
Child response
Comments
tags
[1] tagusers
summaryCreates list of users with given input array
externalDocs
[1] url
description
extensions
operationIdcreateUsersWithArrayInput
deprecated
security
[1] pattern {name}
operation
servers
[1] url
description
variables
extensions
extensions
[1] pattern
value
2.11.2.1.3 post Fields
FieldTypeReqKeyDescriptionComments
parametersarrayfalse
requestBodyrequestBodyfalse

List of user object

application/jsonmediafalse
schemaarrayfalse
[0]objectfalse
idint64false
usernamestringfalse
firstNamestringfalse
lastNamestringfalse
emailstringfalse
passwordstringfalse
phonestringfalse
userStatusint32false

User Status

examplesobjectfalse
encodingobjectfalse
callbacksoperationObjectfalse
2.11.2.1.3.1 Field parameters
2.11.2.1.3.1.1 parameters properties
PropertyValue
Name parameters
Technical name parameters
Id
Type array
Title
Description
Required
Min items
Max items
Unique items
Additional items true
Comments
2.11.2.1.3.2 Field requestBody
2.11.2.1.3.2.1 requestBody properties
PropertyValue
Name requestBody
Technical name
Activated true
Reference type model
Reference description
2.11.2.1.3.3 Field callbacks
2.11.2.1.3.3.1 callbacks properties
PropertyValue
Name callbacks
Technical name
Type operationObject
2.11.2.1.4 post JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "post",
    "properties": {
        "parameters": {
            "type": "array",
            "title": "parameters",
            "additionalItems": true
        },
        "requestBody": {
            "$ref": "#model/definitions/requestBodies/properties/UserArray"
        },
        "callbacks": {
            "type": "object",
            "additionalProperties": false
        }
    },
    "additionalProperties": true
}
2.11.2.1.5 post JSON data
{
    "parameters": [],
    "requestBody": {
        "application/json": {
            "schema": [
                {
                    "id": -39,
                    "username": "Lorem",
                    "firstName": "Lorem",
                    "lastName": "Lorem",
                    "email": "Lorem",
                    "password": "Lorem",
                    "phone": "Lorem",
                    "userStatus": -24
                }
            ],
            "examples": {},
            "encoding": {}
        }
    },
    "callbacks": {}
}
2.11.2.1.6 post Responses:
2.11.2.1.6.1 Response default
2.11.2.1.6.1.1 default Tree Diagram
2.11.2.1.6.1.2 default Properties
PropertyValue
Responsedefault
Activatedtrue
Id
$ref
Description

successful operation

Resources/users/createWithArray
Parent requestpost
Child response
Comments
extensions
[1] pattern
value
2.11.2.1.6.1.3 default Fields
FieldTypeReqKeyDescriptionComments
responseresponsefalse

successful operation

headersobjectfalse
contentobjectfalse
linksobjectfalse
2.11.2.1.6.1.3.1 Field response
2.11.2.1.6.1.3.1.1 response Hierarchy
Parent field: default
Child field(s):
FieldTypeReqKeyDescriptionComments
headersobjectfalse
contentobjectfalse
linksobjectfalse
2.11.2.1.6.1.3.1.2 response properties
PropertyValue
Type response
Comments
Description

successful operation

extensions
2.11.2.1.6.1.3.2 Field headers
2.11.2.1.6.1.3.2.1 headers properties
PropertyValue
Name headers
Technical name headers
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.11.2.1.6.1.3.3 Field content
2.11.2.1.6.1.3.3.1 content properties
PropertyValue
Name content
Technical name content
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.11.2.1.6.1.3.4 Field links
2.11.2.1.6.1.3.4.1 links properties
PropertyValue
Name links
Technical name links
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.11.2.1.6.1.4 default JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "default",
    "description": "successful operation",
    "properties": {
        "response": {
            "type": "object",
            "description": "successful operation",
            "properties": {
                "headers": {
                    "type": "object",
                    "title": "headers",
                    "additionalProperties": false
                },
                "content": {
                    "type": "object",
                    "title": "content",
                    "additionalProperties": false
                },
                "links": {
                    "type": "object",
                    "title": "links",
                    "additionalProperties": false
                }
            },
            "additionalProperties": false
        }
    },
    "additionalProperties": true
}
2.11.2.1.6.1.5 default JSON data
{
    "response": {
        "headers": {},
        "content": {},
        "links": {}
    }
}
2.12 Resource /users/createWithList
2.12.1 /users/createWithList Properties
PropertyValue
Resource path/users/createWithList
Activatedtrue
Description
summary
extensions
[1] pattern
value
Comments
2.12.2 /users/createWithList Requests
2.12.2.1 Request post
2.12.2.1.1 post Tree Diagram
2.12.2.1.2 post Properties
PropertyValue
Request operationpost
Activatedtrue
Id
$ref
Description
Resources/users/createWithList
Parent request
Child response
Comments
tags
[1] tagusers
summaryCreates list of users with given input array
externalDocs
[1] url
description
extensions
operationIdcreateUsersWithListInput
deprecated
security
[1] pattern {name}
operation
servers
[1] url
description
variables
extensions
extensions
[1] pattern
value
2.12.2.1.3 post Fields
FieldTypeReqKeyDescriptionComments
parametersarrayfalse
requestBodyrequestBodyfalse

List of user object

application/jsonmediafalse
schemaarrayfalse
[0]objectfalse
idint64false
usernamestringfalse
firstNamestringfalse
lastNamestringfalse
emailstringfalse
passwordstringfalse
phonestringfalse
userStatusint32false

User Status

examplesobjectfalse
encodingobjectfalse
callbacksoperationObjectfalse
2.12.2.1.3.1 Field parameters
2.12.2.1.3.1.1 parameters properties
PropertyValue
Name parameters
Technical name parameters
Id
Type array
Title
Description
Required
Min items
Max items
Unique items
Additional items true
Comments
2.12.2.1.3.2 Field requestBody
2.12.2.1.3.2.1 requestBody properties
PropertyValue
Name requestBody
Technical name
Activated true
Reference type model
Reference description
2.12.2.1.3.3 Field callbacks
2.12.2.1.3.3.1 callbacks properties
PropertyValue
Name callbacks
Technical name
Type operationObject
2.12.2.1.4 post JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "post",
    "properties": {
        "parameters": {
            "type": "array",
            "title": "parameters",
            "additionalItems": true
        },
        "requestBody": {
            "$ref": "#model/definitions/requestBodies/properties/UserArray"
        },
        "callbacks": {
            "type": "object",
            "additionalProperties": false
        }
    },
    "additionalProperties": true
}
2.12.2.1.5 post JSON data
{
    "parameters": [],
    "requestBody": {
        "application/json": {
            "schema": [
                {
                    "id": -76,
                    "username": "Lorem",
                    "firstName": "Lorem",
                    "lastName": "Lorem",
                    "email": "Lorem",
                    "password": "Lorem",
                    "phone": "Lorem",
                    "userStatus": -77
                }
            ],
            "examples": {},
            "encoding": {}
        }
    },
    "callbacks": {}
}
2.12.2.1.6 post Responses:
2.12.2.1.6.1 Response default
2.12.2.1.6.1.1 default Tree Diagram
2.12.2.1.6.1.2 default Properties
PropertyValue
Responsedefault
Activatedtrue
Id
$ref
Description

successful operation

Resources/users/createWithList
Parent requestpost
Child response
Comments
extensions
[1] pattern
value
2.12.2.1.6.1.3 default Fields
FieldTypeReqKeyDescriptionComments
responseresponsefalse

successful operation

headersobjectfalse
contentobjectfalse
linksobjectfalse
2.12.2.1.6.1.3.1 Field response
2.12.2.1.6.1.3.1.1 response Hierarchy
Parent field: default
Child field(s):
FieldTypeReqKeyDescriptionComments
headersobjectfalse
contentobjectfalse
linksobjectfalse
2.12.2.1.6.1.3.1.2 response properties
PropertyValue
Type response
Comments
Description

successful operation

extensions
2.12.2.1.6.1.3.2 Field headers
2.12.2.1.6.1.3.2.1 headers properties
PropertyValue
Name headers
Technical name headers
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.12.2.1.6.1.3.3 Field content
2.12.2.1.6.1.3.3.1 content properties
PropertyValue
Name content
Technical name content
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.12.2.1.6.1.3.4 Field links
2.12.2.1.6.1.3.4.1 links properties
PropertyValue
Name links
Technical name links
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.12.2.1.6.1.4 default JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "default",
    "description": "successful operation",
    "properties": {
        "response": {
            "type": "object",
            "description": "successful operation",
            "properties": {
                "headers": {
                    "type": "object",
                    "title": "headers",
                    "additionalProperties": false
                },
                "content": {
                    "type": "object",
                    "title": "content",
                    "additionalProperties": false
                },
                "links": {
                    "type": "object",
                    "title": "links",
                    "additionalProperties": false
                }
            },
            "additionalProperties": false
        }
    },
    "additionalProperties": true
}
2.12.2.1.6.1.5 default JSON data
{
    "response": {
        "headers": {},
        "content": {},
        "links": {}
    }
}
2.13 Resource /users/login
2.13.1 /users/login Properties
PropertyValue
Resource path/users/login
Activatedtrue
Description
summary
extensions
[1] pattern
value
Comments
2.13.2 /users/login Requests
2.13.2.1 Request get
2.13.2.1.1 get Tree Diagram
2.13.2.1.2 get Properties
PropertyValue
Request operationget
Activatedtrue
Id
$ref
Description
Resources/users/login
Parent request
Child response
Comments
tags
[1] tagusers
summaryLogs user into the system
externalDocs
[1] url
description
extensions
operationIdloginUser
deprecated
security
[1] pattern {name}
operation
servers
[1] url
description
variables
extensions
extensions
[1] pattern
value
2.13.2.1.3 get Fields
FieldTypeReqKeyDescriptionComments
parametersarrayfalse
[0] usernameparameter (query)true

The user name for login

schemastringfalse
contentobjectfalse
examplesobjectfalse
[1] passwordparameter (query)true

The password for login in clear text

schemapasswordfalse
contentobjectfalse
examplesobjectfalse
requestBodyrequestBodyfalse
callbacksoperationObjectfalse
2.13.2.1.3.1 Field parameters
2.13.2.1.3.1.1 parameters Hierarchy
Parent field: get
Child field(s):
FieldTypeReqKeyDescriptionComments
[0] usernameparameter (query)true

The user name for login

[1] passwordparameter (query)true

The password for login in clear text

2.13.2.1.3.1.2 parameters properties
PropertyValue
Name parameters
Technical name parameters
Id
Type array
Title
Description
Required
Min items
Max items
Unique items
Additional items true
Comments
2.13.2.1.3.2 Field [0] username
2.13.2.1.3.2.1 [0] username Hierarchy
Parent field: parameters
Child field(s):
FieldTypeReqKeyDescriptionComments
schemastringfalse
contentobjectfalse
examplesobjectfalse
2.13.2.1.3.2.2 [0] username properties
PropertyValue
Display name username
Activated true
Parameter name username
Type parameter (query)
Description

The user name for login

Comments
Required true
Deprecated
Allow empty value
Style
Explode
Allow Reserved
example
extensions
2.13.2.1.3.3 Field schema
2.13.2.1.3.3.1 schema properties
PropertyValue
Name schema
Technical name
Activated true
Id
Type string
Format
Title
Description
Required
Deprecated
Default
Min length
Max length
Pattern
Enum
Faker function
example (deprecated)
nullable
readOnly
writeOnly
xml
externalDocs
Comments
2.13.2.1.3.4 Field content
2.13.2.1.3.4.1 content properties
PropertyValue
Name content
Technical name content
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.13.2.1.3.5 Field examples
2.13.2.1.3.5.1 examples properties
PropertyValue
Name examples
Technical name examples
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.13.2.1.3.6 Field [1] password
2.13.2.1.3.6.1 [1] password Hierarchy
Parent field: parameters
Child field(s):
FieldTypeReqKeyDescriptionComments
schemastringfalse
contentobjectfalse
examplesobjectfalse
2.13.2.1.3.6.2 [1] password properties
PropertyValue
Display name password
Activated true
Parameter name password
Type parameter (query)
Description

The password for login in clear text

Comments
Required true
Deprecated
Allow empty value
Style
Explode
Allow Reserved
example
extensions
2.13.2.1.3.7 Field schema
2.13.2.1.3.7.1 schema properties
PropertyValue
Name schema
Technical name
Activated true
Id
Type string
Format password
Title
Description
Required
Deprecated
Default
Min length
Max length
Pattern
Enum
Faker function
example (deprecated)
nullable
readOnly
writeOnly
xml
externalDocs
Comments
2.13.2.1.3.8 Field content
2.13.2.1.3.8.1 content properties
PropertyValue
Name content
Technical name content
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.13.2.1.3.9 Field examples
2.13.2.1.3.9.1 examples properties
PropertyValue
Name examples
Technical name examples
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.13.2.1.3.10 Field requestBody
2.13.2.1.3.10.1 requestBody properties
PropertyValue
Name requestBody
Technical name
Comments
Type requestBody
Required
Description
extensions
2.13.2.1.3.11 Field callbacks
2.13.2.1.3.11.1 callbacks properties
PropertyValue
Name callbacks
Technical name
Type operationObject
2.13.2.1.4 get JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "get",
    "properties": {
        "parameters": {
            "type": "array",
            "title": "parameters",
            "additionalItems": true,
            "items": [
                {
                    "type": "object",
                    "description": "The user name for login",
                    "properties": {
                        "schema": {
                            "type": "string"
                        },
                        "content": {
                            "type": "object",
                            "title": "content",
                            "additionalProperties": false
                        },
                        "examples": {
                            "type": "object",
                            "title": "examples",
                            "additionalProperties": false
                        }
                    },
                    "additionalProperties": false
                },
                {
                    "type": "object",
                    "description": "The password for login in clear text",
                    "properties": {
                        "schema": {
                            "type": "string",
                            "format": "password"
                        },
                        "content": {
                            "type": "object",
                            "title": "content",
                            "additionalProperties": false
                        },
                        "examples": {
                            "type": "object",
                            "title": "examples",
                            "additionalProperties": false
                        }
                    },
                    "additionalProperties": false
                }
            ]
        },
        "requestBody": {
            "type": "object",
            "additionalProperties": false
        },
        "callbacks": {
            "type": "object",
            "additionalProperties": false
        }
    },
    "additionalProperties": true
}
2.13.2.1.5 get JSON data
{
    "parameters": [
        {
            "schema": "Lorem",
            "content": {},
            "examples": {}
        },
        {
            "content": {},
            "examples": {}
        }
    ],
    "requestBody": {},
    "callbacks": {}
}
2.13.2.1.6 get Responses:
2.13.2.1.6.1 Response 200
2.13.2.1.6.1.1 200 Tree Diagram
2.13.2.1.6.1.2 200 Properties
PropertyValue
Response200
Activatedtrue
Id
$ref
Description

successful operation

Resources/users/login
Parent requestget
Child response
Comments
extensions
[1] pattern
value
2.13.2.1.6.1.3 200 Fields
FieldTypeReqKeyDescriptionComments
responseresponsefalse

successful operation

headersobjectfalse
X-Rate-Limitheaderfalse

calls per hour allowed by the user

schemaint32false
contentobjectfalse
examplesobjectfalse
X-Expires-Afterheaderfalse

date in UTC when token expires

schemadate-timefalse
contentobjectfalse
examplesobjectfalse
contentobjectfalse
application/xmlmediafalse
schemastringfalse
examplesobjectfalse
encodingobjectfalse
application/jsonmediafalse
schemastringfalse
examplesobjectfalse
encodingobjectfalse
linksobjectfalse
2.13.2.1.6.1.3.1 Field response
2.13.2.1.6.1.3.1.1 response Hierarchy
Parent field: 200
Child field(s):
FieldTypeReqKeyDescriptionComments
headersobjectfalse
contentobjectfalse
linksobjectfalse
2.13.2.1.6.1.3.1.2 response properties
PropertyValue
Type response
Comments
Description

successful operation

extensions
2.13.2.1.6.1.3.2 Field headers
2.13.2.1.6.1.3.2.1 headers Hierarchy
Parent field: response
Child field(s):
FieldTypeReqKeyDescriptionComments
X-Rate-Limitheaderfalse

calls per hour allowed by the user

X-Expires-Afterheaderfalse

date in UTC when token expires

2.13.2.1.6.1.3.2.2 headers properties
PropertyValue
Name headers
Technical name headers
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.13.2.1.6.1.3.3 Field X-Rate-Limit
2.13.2.1.6.1.3.3.1 X-Rate-Limit Hierarchy
Parent field: headers
Child field(s):
FieldTypeReqKeyDescriptionComments
schemaintegerfalse
contentobjectfalse
examplesobjectfalse
2.13.2.1.6.1.3.3.2 X-Rate-Limit properties
PropertyValue
Name X-Rate-Limit
Technical name
Activated true
Type header
Description

calls per hour allowed by the user

Comments
Required
Deprecated
Allow empty value
Style
Explode
Allow Reserved
example
extensions
2.13.2.1.6.1.3.4 Field schema
2.13.2.1.6.1.3.4.1 schema properties
PropertyValue
Name schema
Technical name
Activated true
Id
Type integer
Format int32
Title
Description
Required
Deprecated
Default
Min value
Excl min
Max value
Excl max
Multiple of
Enum
Faker function
example (deprecated)
nullable
readOnly
xml
externalDocs
Comments
2.13.2.1.6.1.3.5 Field content
2.13.2.1.6.1.3.5.1 content properties
PropertyValue
Name content
Technical name content
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.13.2.1.6.1.3.6 Field examples
2.13.2.1.6.1.3.6.1 examples properties
PropertyValue
Name examples
Technical name examples
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.13.2.1.6.1.3.7 Field X-Expires-After
2.13.2.1.6.1.3.7.1 X-Expires-After Hierarchy
Parent field: headers
Child field(s):
FieldTypeReqKeyDescriptionComments
schemastringfalse
contentobjectfalse
examplesobjectfalse
2.13.2.1.6.1.3.7.2 X-Expires-After properties
PropertyValue
Name X-Expires-After
Technical name
Activated true
Type header
Description

date in UTC when token expires

Comments
Required
Deprecated
Allow empty value
Style
Explode
Allow Reserved
example
extensions
2.13.2.1.6.1.3.8 Field schema
2.13.2.1.6.1.3.8.1 schema properties
PropertyValue
Name schema
Technical name
Activated true
Id
Type string
Format date-time
Title
Description
Required
Deprecated
Default
Min length
Max length
Pattern
Enum
Faker function
example (deprecated)
nullable
readOnly
writeOnly
xml
externalDocs
Comments
2.13.2.1.6.1.3.9 Field content
2.13.2.1.6.1.3.9.1 content properties
PropertyValue
Name content
Technical name content
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.13.2.1.6.1.3.10 Field examples
2.13.2.1.6.1.3.10.1 examples properties
PropertyValue
Name examples
Technical name examples
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.13.2.1.6.1.3.11 Field content
2.13.2.1.6.1.3.11.1 content Hierarchy
Parent field: response
Child field(s):
FieldTypeReqKeyDescriptionComments
application/xmlmediafalse
application/jsonmediafalse
2.13.2.1.6.1.3.11.2 content properties
PropertyValue
Name content
Technical name content
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.13.2.1.6.1.3.12 Field application/xml
2.13.2.1.6.1.3.12.1 application/xml Hierarchy
Parent field: content
Child field(s):
FieldTypeReqKeyDescriptionComments
schemastringfalse
examplesobjectfalse
encodingobjectfalse
2.13.2.1.6.1.3.12.2 application/xml properties
PropertyValue
Name application/xml
Activated true
Description
Comments
example
Type media
extensions
2.13.2.1.6.1.3.13 Field schema
2.13.2.1.6.1.3.13.1 schema properties
PropertyValue
Name schema
Technical name
Activated true
Id
Type string
Format
Title
Description
Required
Deprecated
Default
Min length
Max length
Pattern
Enum
Faker function
example (deprecated)
nullable
readOnly
writeOnly
xml
externalDocs
Comments
2.13.2.1.6.1.3.14 Field examples
2.13.2.1.6.1.3.14.1 examples properties
PropertyValue
Name examples
Technical name examples
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.13.2.1.6.1.3.15 Field encoding
2.13.2.1.6.1.3.15.1 encoding properties
PropertyValue
Name encoding
Technical name encoding
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.13.2.1.6.1.3.16 Field application/json
2.13.2.1.6.1.3.16.1 application/json Hierarchy
Parent field: content
Child field(s):
FieldTypeReqKeyDescriptionComments
schemastringfalse
examplesobjectfalse
encodingobjectfalse
2.13.2.1.6.1.3.16.2 application/json properties
PropertyValue
Name application/json
Activated true
Description
Comments
example
Type media
extensions
2.13.2.1.6.1.3.17 Field schema
2.13.2.1.6.1.3.17.1 schema properties
PropertyValue
Name schema
Technical name
Activated true
Id
Type string
Format
Title
Description
Required
Deprecated
Default
Min length
Max length
Pattern
Enum
Faker function
example (deprecated)
nullable
readOnly
writeOnly
xml
externalDocs
Comments
2.13.2.1.6.1.3.18 Field examples
2.13.2.1.6.1.3.18.1 examples properties
PropertyValue
Name examples
Technical name examples
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.13.2.1.6.1.3.19 Field encoding
2.13.2.1.6.1.3.19.1 encoding properties
PropertyValue
Name encoding
Technical name encoding
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.13.2.1.6.1.3.20 Field links
2.13.2.1.6.1.3.20.1 links properties
PropertyValue
Name links
Technical name links
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.13.2.1.6.1.4 200 JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "200",
    "description": "successful operation",
    "properties": {
        "response": {
            "type": "object",
            "description": "successful operation",
            "properties": {
                "headers": {
                    "type": "object",
                    "title": "headers",
                    "properties": {
                        "X-Rate-Limit": {
                            "type": "object",
                            "description": "calls per hour allowed by the user",
                            "properties": {
                                "schema": {
                                    "type": "number"
                                },
                                "content": {
                                    "type": "object",
                                    "title": "content",
                                    "additionalProperties": false
                                },
                                "examples": {
                                    "type": "object",
                                    "title": "examples",
                                    "additionalProperties": false
                                }
                            },
                            "additionalProperties": false
                        },
                        "X-Expires-After": {
                            "type": "object",
                            "description": "date in UTC when token expires",
                            "properties": {
                                "schema": {
                                    "type": "string",
                                    "format": "date-time"
                                },
                                "content": {
                                    "type": "object",
                                    "title": "content",
                                    "additionalProperties": false
                                },
                                "examples": {
                                    "type": "object",
                                    "title": "examples",
                                    "additionalProperties": false
                                }
                            },
                            "additionalProperties": false
                        }
                    },
                    "additionalProperties": false
                },
                "content": {
                    "type": "object",
                    "title": "content",
                    "properties": {
                        "application/xml": {
                            "type": "object",
                            "properties": {
                                "schema": {
                                    "type": "string"
                                },
                                "examples": {
                                    "type": "object",
                                    "title": "examples",
                                    "additionalProperties": false
                                },
                                "encoding": {
                                    "type": "object",
                                    "title": "encoding",
                                    "additionalProperties": false
                                }
                            },
                            "additionalProperties": false
                        },
                        "application/json": {
                            "type": "object",
                            "properties": {
                                "schema": {
                                    "type": "string"
                                },
                                "examples": {
                                    "type": "object",
                                    "title": "examples",
                                    "additionalProperties": false
                                },
                                "encoding": {
                                    "type": "object",
                                    "title": "encoding",
                                    "additionalProperties": false
                                }
                            },
                            "additionalProperties": false
                        }
                    },
                    "additionalProperties": false
                },
                "links": {
                    "type": "object",
                    "title": "links",
                    "additionalProperties": false
                }
            },
            "additionalProperties": false
        }
    },
    "additionalProperties": true
}
2.13.2.1.6.1.5 200 JSON data
{
    "response": {
        "headers": {
            "X-Rate-Limit": {
                "schema": -43,
                "content": {},
                "examples": {}
            },
            "X-Expires-After": {
                "schema": "2011-06-14T04:12:36.123Z",
                "content": {},
                "examples": {}
            }
        },
        "content": {
            "application/xml": {
                "schema": "Lorem",
                "examples": {},
                "encoding": {}
            },
            "application/json": {
                "schema": "Lorem",
                "examples": {},
                "encoding": {}
            }
        },
        "links": {}
    }
}
2.13.2.1.6.2 Response 400
2.13.2.1.6.2.1 400 Tree Diagram
2.13.2.1.6.2.2 400 Properties
PropertyValue
Response400
Activatedtrue
Id
$ref
Description

Invalid username/password supplied

Resources/users/login
Parent requestget
Child response
Comments
extensions
[1] pattern
value
2.13.2.1.6.2.3 400 Fields
FieldTypeReqKeyDescriptionComments
responseresponsefalse

Invalid username/password supplied

headersobjectfalse
contentobjectfalse
linksobjectfalse
2.13.2.1.6.2.3.1 Field response
2.13.2.1.6.2.3.1.1 response Hierarchy
Parent field: 400
Child field(s):
FieldTypeReqKeyDescriptionComments
headersobjectfalse
contentobjectfalse
linksobjectfalse
2.13.2.1.6.2.3.1.2 response properties
PropertyValue
Type response
Comments
Description

Invalid username/password supplied

extensions
2.13.2.1.6.2.3.2 Field headers
2.13.2.1.6.2.3.2.1 headers properties
PropertyValue
Name headers
Technical name headers
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.13.2.1.6.2.3.3 Field content
2.13.2.1.6.2.3.3.1 content properties
PropertyValue
Name content
Technical name content
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.13.2.1.6.2.3.4 Field links
2.13.2.1.6.2.3.4.1 links properties
PropertyValue
Name links
Technical name links
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.13.2.1.6.2.4 400 JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "400",
    "description": "Invalid username/password supplied",
    "properties": {
        "response": {
            "type": "object",
            "description": "Invalid username/password supplied",
            "properties": {
                "headers": {
                    "type": "object",
                    "title": "headers",
                    "additionalProperties": false
                },
                "content": {
                    "type": "object",
                    "title": "content",
                    "additionalProperties": false
                },
                "links": {
                    "type": "object",
                    "title": "links",
                    "additionalProperties": false
                }
            },
            "additionalProperties": false
        }
    },
    "additionalProperties": true
}
2.13.2.1.6.2.5 400 JSON data
{
    "response": {
        "headers": {},
        "content": {},
        "links": {}
    }
}
2.14 Resource /users/logout
2.14.1 /users/logout Properties
PropertyValue
Resource path/users/logout
Activatedtrue
Description
summary
extensions
[1] pattern
value
Comments
2.14.2 /users/logout Requests
2.14.2.1 Request get
2.14.2.1.1 get Tree Diagram
2.14.2.1.2 get Properties
PropertyValue
Request operationget
Activatedtrue
Id
$ref
Description
Resources/users/logout
Parent request
Child response
Comments
tags
[1] tagusers
summaryLogs out current logged in user session
externalDocs
[1] url
description
extensions
operationIdlogoutUser
deprecated
security
[1] pattern {name}
operation
servers
[1] url
description
variables
extensions
extensions
[1] pattern
value
2.14.2.1.3 get Fields
FieldTypeReqKeyDescriptionComments
parametersarrayfalse
requestBodyrequestBodyfalse
callbacksoperationObjectfalse
2.14.2.1.3.1 Field parameters
2.14.2.1.3.1.1 parameters properties
PropertyValue
Name parameters
Technical name parameters
Id
Type array
Title
Description
Required
Min items
Max items
Unique items
Additional items true
Comments
2.14.2.1.3.2 Field requestBody
2.14.2.1.3.2.1 requestBody properties
PropertyValue
Name requestBody
Technical name
Comments
Type requestBody
Required
Description
extensions
2.14.2.1.3.3 Field callbacks
2.14.2.1.3.3.1 callbacks properties
PropertyValue
Name callbacks
Technical name
Type operationObject
2.14.2.1.4 get JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "get",
    "properties": {
        "parameters": {
            "type": "array",
            "title": "parameters",
            "additionalItems": true
        },
        "requestBody": {
            "type": "object",
            "additionalProperties": false
        },
        "callbacks": {
            "type": "object",
            "additionalProperties": false
        }
    },
    "additionalProperties": true
}
2.14.2.1.5 get JSON data
{
    "parameters": [],
    "requestBody": {},
    "callbacks": {}
}
2.14.2.1.6 get Responses:
2.14.2.1.6.1 Response default
2.14.2.1.6.1.1 default Tree Diagram
2.14.2.1.6.1.2 default Properties
PropertyValue
Responsedefault
Activatedtrue
Id
$ref
Description

successful operation

Resources/users/logout
Parent requestget
Child response
Comments
extensions
[1] pattern
value
2.14.2.1.6.1.3 default Fields
FieldTypeReqKeyDescriptionComments
responseresponsefalse

successful operation

headersobjectfalse
contentobjectfalse
linksobjectfalse
2.14.2.1.6.1.3.1 Field response
2.14.2.1.6.1.3.1.1 response Hierarchy
Parent field: default
Child field(s):
FieldTypeReqKeyDescriptionComments
headersobjectfalse
contentobjectfalse
linksobjectfalse
2.14.2.1.6.1.3.1.2 response properties
PropertyValue
Type response
Comments
Description

successful operation

extensions
2.14.2.1.6.1.3.2 Field headers
2.14.2.1.6.1.3.2.1 headers properties
PropertyValue
Name headers
Technical name headers
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.14.2.1.6.1.3.3 Field content
2.14.2.1.6.1.3.3.1 content properties
PropertyValue
Name content
Technical name content
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.14.2.1.6.1.3.4 Field links
2.14.2.1.6.1.3.4.1 links properties
PropertyValue
Name links
Technical name links
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.14.2.1.6.1.4 default JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "default",
    "description": "successful operation",
    "properties": {
        "response": {
            "type": "object",
            "description": "successful operation",
            "properties": {
                "headers": {
                    "type": "object",
                    "title": "headers",
                    "additionalProperties": false
                },
                "content": {
                    "type": "object",
                    "title": "content",
                    "additionalProperties": false
                },
                "links": {
                    "type": "object",
                    "title": "links",
                    "additionalProperties": false
                }
            },
            "additionalProperties": false
        }
    },
    "additionalProperties": true
}
2.14.2.1.6.1.5 default JSON data
{
    "response": {
        "headers": {},
        "content": {},
        "links": {}
    }
}
2.15 Resource /users/{username}
2.15.1 /users/{username} Properties
PropertyValue
Resource path/users/{username}
Activatedtrue
Description
summary
extensions
[1] pattern
value
Comments
2.15.2 /users/{username} Requests
2.15.2.1 Request delete
2.15.2.1.1 delete Tree Diagram
2.15.2.1.2 delete Properties
PropertyValue
Request operationdelete
Activatedtrue
Id
$ref
Description

This can only be done by the logged in user.

Resources/users/{username}
Parent request
Child response
Comments
tags
[1] tagusers
summaryDelete user
externalDocs
[1] url
description
extensions
operationIddeleteUser
deprecated
security
[1] pattern {name}
operation
servers
[1] url
description
variables
extensions
extensions
[1] pattern
value
2.15.2.1.3 delete Fields
FieldTypeReqKeyDescriptionComments
parametersarrayfalse
[0] usernameparameter (path)true

The name that needs to be deleted

schemastringfalse
contentobjectfalse
examplesobjectfalse
requestBodyrequestBodyfalse
callbacksoperationObjectfalse
2.15.2.1.3.1 Field parameters
2.15.2.1.3.1.1 parameters Hierarchy
Parent field: delete
Child field(s):
FieldTypeReqKeyDescriptionComments
[0] usernameparameter (path)true

The name that needs to be deleted

2.15.2.1.3.1.2 parameters properties
PropertyValue
Name parameters
Technical name parameters
Id
Type array
Title
Description
Required
Min items
Max items
Unique items
Additional items true
Comments
2.15.2.1.3.2 Field [0] username
2.15.2.1.3.2.1 [0] username Hierarchy
Parent field: parameters
Child field(s):
FieldTypeReqKeyDescriptionComments
schemastringfalse
contentobjectfalse
examplesobjectfalse
2.15.2.1.3.2.2 [0] username properties
PropertyValue
Display name username
Activated true
Parameter name username
Type parameter (path)
Description

The name that needs to be deleted

Comments
Required true
Deprecated
Allow empty value
Style
Explode
Allow Reserved
example
extensions
2.15.2.1.3.3 Field schema
2.15.2.1.3.3.1 schema properties
PropertyValue
Name schema
Technical name
Activated true
Id
Type string
Format
Title
Description
Required
Deprecated
Default
Min length
Max length
Pattern
Enum
Faker function
example (deprecated)
nullable
readOnly
writeOnly
xml
externalDocs
Comments
2.15.2.1.3.4 Field content
2.15.2.1.3.4.1 content properties
PropertyValue
Name content
Technical name content
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.15.2.1.3.5 Field examples
2.15.2.1.3.5.1 examples properties
PropertyValue
Name examples
Technical name examples
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.15.2.1.3.6 Field requestBody
2.15.2.1.3.6.1 requestBody properties
PropertyValue
Name requestBody
Technical name
Comments
Type requestBody
Required
Description
extensions
2.15.2.1.3.7 Field callbacks
2.15.2.1.3.7.1 callbacks properties
PropertyValue
Name callbacks
Technical name
Type operationObject
2.15.2.1.4 delete JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "delete",
    "description": "This can only be done by the logged in user.",
    "properties": {
        "parameters": {
            "type": "array",
            "title": "parameters",
            "additionalItems": true,
            "items": {
                "type": "object",
                "description": "The name that needs to be deleted",
                "properties": {
                    "schema": {
                        "type": "string"
                    },
                    "content": {
                        "type": "object",
                        "title": "content",
                        "additionalProperties": false
                    },
                    "examples": {
                        "type": "object",
                        "title": "examples",
                        "additionalProperties": false
                    }
                },
                "additionalProperties": false
            }
        },
        "requestBody": {
            "type": "object",
            "additionalProperties": false
        },
        "callbacks": {
            "type": "object",
            "additionalProperties": false
        }
    },
    "additionalProperties": true
}
2.15.2.1.5 delete JSON data
{
    "parameters": [
        {
            "schema": "Lorem",
            "content": {},
            "examples": {}
        }
    ],
    "requestBody": {},
    "callbacks": {}
}
2.15.2.1.6 delete Responses:
2.15.2.1.6.1 Response 400
2.15.2.1.6.1.1 400 Tree Diagram
2.15.2.1.6.1.2 400 Properties
PropertyValue
Response400
Activatedtrue
Id
$ref
Description

Invalid username supplied

Resources/users/{username}
Parent requestdelete
Child response
Comments
extensions
[1] pattern
value
2.15.2.1.6.1.3 400 Fields
FieldTypeReqKeyDescriptionComments
responseresponsefalse

Invalid username supplied

headersobjectfalse
contentobjectfalse
linksobjectfalse
2.15.2.1.6.1.3.1 Field response
2.15.2.1.6.1.3.1.1 response Hierarchy
Parent field: 400
Child field(s):
FieldTypeReqKeyDescriptionComments
headersobjectfalse
contentobjectfalse
linksobjectfalse
2.15.2.1.6.1.3.1.2 response properties
PropertyValue
Type response
Comments
Description

Invalid username supplied

extensions
2.15.2.1.6.1.3.2 Field headers
2.15.2.1.6.1.3.2.1 headers properties
PropertyValue
Name headers
Technical name headers
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.15.2.1.6.1.3.3 Field content
2.15.2.1.6.1.3.3.1 content properties
PropertyValue
Name content
Technical name content
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.15.2.1.6.1.3.4 Field links
2.15.2.1.6.1.3.4.1 links properties
PropertyValue
Name links
Technical name links
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.15.2.1.6.1.4 400 JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "400",
    "description": "Invalid username supplied",
    "properties": {
        "response": {
            "type": "object",
            "description": "Invalid username supplied",
            "properties": {
                "headers": {
                    "type": "object",
                    "title": "headers",
                    "additionalProperties": false
                },
                "content": {
                    "type": "object",
                    "title": "content",
                    "additionalProperties": false
                },
                "links": {
                    "type": "object",
                    "title": "links",
                    "additionalProperties": false
                }
            },
            "additionalProperties": false
        }
    },
    "additionalProperties": true
}
2.15.2.1.6.1.5 400 JSON data
{
    "response": {
        "headers": {},
        "content": {},
        "links": {}
    }
}
2.15.2.1.6.2 Response 404
2.15.2.1.6.2.1 404 Tree Diagram
2.15.2.1.6.2.2 404 Properties
PropertyValue
Response404
Activatedtrue
Id
$ref
Description

User not found

Resources/users/{username}
Parent requestdelete
Child response
Comments
extensions
[1] pattern
value
2.15.2.1.6.2.3 404 Fields
FieldTypeReqKeyDescriptionComments
responseresponsefalse

User not found

headersobjectfalse
contentobjectfalse
linksobjectfalse
2.15.2.1.6.2.3.1 Field response
2.15.2.1.6.2.3.1.1 response Hierarchy
Parent field: 404
Child field(s):
FieldTypeReqKeyDescriptionComments
headersobjectfalse
contentobjectfalse
linksobjectfalse
2.15.2.1.6.2.3.1.2 response properties
PropertyValue
Type response
Comments
Description

User not found

extensions
2.15.2.1.6.2.3.2 Field headers
2.15.2.1.6.2.3.2.1 headers properties
PropertyValue
Name headers
Technical name headers
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.15.2.1.6.2.3.3 Field content
2.15.2.1.6.2.3.3.1 content properties
PropertyValue
Name content
Technical name content
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.15.2.1.6.2.3.4 Field links
2.15.2.1.6.2.3.4.1 links properties
PropertyValue
Name links
Technical name links
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.15.2.1.6.2.4 404 JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "404",
    "description": "User not found",
    "properties": {
        "response": {
            "type": "object",
            "description": "User not found",
            "properties": {
                "headers": {
                    "type": "object",
                    "title": "headers",
                    "additionalProperties": false
                },
                "content": {
                    "type": "object",
                    "title": "content",
                    "additionalProperties": false
                },
                "links": {
                    "type": "object",
                    "title": "links",
                    "additionalProperties": false
                }
            },
            "additionalProperties": false
        }
    },
    "additionalProperties": true
}
2.15.2.1.6.2.5 404 JSON data
{
    "response": {
        "headers": {},
        "content": {},
        "links": {}
    }
}
2.15.2.2 Request get
2.15.2.2.1 get Tree Diagram
2.15.2.2.2 get Properties
PropertyValue
Request operationget
Activatedtrue
Id
$ref
Description
Resources/users/{username}
Parent request
Child response
Comments
tags
[1] tagusers
summaryGet user by user name
externalDocs
[1] url
description
extensions
operationIdgetUserByName
deprecated
security
[1] pattern {name}
operation
servers
[1] url
description
variables
extensions
extensions
[1] pattern
value
2.15.2.2.3 get Fields
FieldTypeReqKeyDescriptionComments
parametersarrayfalse
[0] usernameparameter (path)true

The name that needs to be fetched. Use user1 for testing.

schemastringfalse
contentobjectfalse
examplesobjectfalse
requestBodyrequestBodyfalse
callbacksoperationObjectfalse
2.15.2.2.3.1 Field parameters
2.15.2.2.3.1.1 parameters Hierarchy
Parent field: get
Child field(s):
FieldTypeReqKeyDescriptionComments
[0] usernameparameter (path)true

The name that needs to be fetched. Use user1 for testing.

2.15.2.2.3.1.2 parameters properties
PropertyValue
Name parameters
Technical name parameters
Id
Type array
Title
Description
Required
Min items
Max items
Unique items
Additional items true
Comments
2.15.2.2.3.2 Field [0] username
2.15.2.2.3.2.1 [0] username Hierarchy
Parent field: parameters
Child field(s):
FieldTypeReqKeyDescriptionComments
schemastringfalse
contentobjectfalse
examplesobjectfalse
2.15.2.2.3.2.2 [0] username properties
PropertyValue
Display name username
Activated true
Parameter name username
Type parameter (path)
Description

The name that needs to be fetched. Use user1 for testing.

Comments
Required true
Deprecated
Allow empty value
Style
Explode
Allow Reserved
example
extensions
2.15.2.2.3.3 Field schema
2.15.2.2.3.3.1 schema properties
PropertyValue
Name schema
Technical name
Activated true
Id
Type string
Format
Title
Description
Required
Deprecated
Default
Min length
Max length
Pattern
Enum
Faker function
example (deprecated)
nullable
readOnly
writeOnly
xml
externalDocs
Comments
2.15.2.2.3.4 Field content
2.15.2.2.3.4.1 content properties
PropertyValue
Name content
Technical name content
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.15.2.2.3.5 Field examples
2.15.2.2.3.5.1 examples properties
PropertyValue
Name examples
Technical name examples
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.15.2.2.3.6 Field requestBody
2.15.2.2.3.6.1 requestBody properties
PropertyValue
Name requestBody
Technical name
Comments
Type requestBody
Required
Description
extensions
2.15.2.2.3.7 Field callbacks
2.15.2.2.3.7.1 callbacks properties
PropertyValue
Name callbacks
Technical name
Type operationObject
2.15.2.2.4 get JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "get",
    "properties": {
        "parameters": {
            "type": "array",
            "title": "parameters",
            "additionalItems": true,
            "items": {
                "type": "object",
                "description": "The name that needs to be fetched. Use user1 for testing. ",
                "properties": {
                    "schema": {
                        "type": "string"
                    },
                    "content": {
                        "type": "object",
                        "title": "content",
                        "additionalProperties": false
                    },
                    "examples": {
                        "type": "object",
                        "title": "examples",
                        "additionalProperties": false
                    }
                },
                "additionalProperties": false
            }
        },
        "requestBody": {
            "type": "object",
            "additionalProperties": false
        },
        "callbacks": {
            "type": "object",
            "additionalProperties": false
        }
    },
    "additionalProperties": true
}
2.15.2.2.5 get JSON data
{
    "parameters": [
        {
            "schema": "Lorem",
            "content": {},
            "examples": {}
        }
    ],
    "requestBody": {},
    "callbacks": {}
}
2.15.2.2.6 get Responses:
2.15.2.2.6.1 Response 200
2.15.2.2.6.1.1 200 Tree Diagram
2.15.2.2.6.1.2 200 Properties
PropertyValue
Response200
Activatedtrue
Id
$ref
Description

successful operation

Resources/users/{username}
Parent requestget
Child response
Comments
extensions
[1] pattern
value
2.15.2.2.6.1.3 200 Fields
FieldTypeReqKeyDescriptionComments
responseresponsefalse

successful operation

headersobjectfalse
contentobjectfalse
application/xmlmediafalse
schemaobjectfalse
idint64false
usernamestringfalse
firstNamestringfalse
lastNamestringfalse
emailstringfalse
passwordstringfalse
phonestringfalse
userStatusint32false

User Status

examplesobjectfalse
encodingobjectfalse
application/jsonmediafalse
schemaobjectfalse
idint64false
usernamestringfalse
firstNamestringfalse
lastNamestringfalse
emailstringfalse
passwordstringfalse
phonestringfalse
userStatusint32false

User Status

examplesobjectfalse
encodingobjectfalse
linksobjectfalse
2.15.2.2.6.1.3.1 Field response
2.15.2.2.6.1.3.1.1 response Hierarchy
Parent field: 200
Child field(s):
FieldTypeReqKeyDescriptionComments
headersobjectfalse
contentobjectfalse
linksobjectfalse
2.15.2.2.6.1.3.1.2 response properties
PropertyValue
Type response
Comments
Description

successful operation

extensions
2.15.2.2.6.1.3.2 Field headers
2.15.2.2.6.1.3.2.1 headers properties
PropertyValue
Name headers
Technical name headers
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.15.2.2.6.1.3.3 Field content
2.15.2.2.6.1.3.3.1 content Hierarchy
Parent field: response
Child field(s):
FieldTypeReqKeyDescriptionComments
application/xmlmediafalse
application/jsonmediafalse
2.15.2.2.6.1.3.3.2 content properties
PropertyValue
Name content
Technical name content
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.15.2.2.6.1.3.4 Field application/xml
2.15.2.2.6.1.3.4.1 application/xml Hierarchy
Parent field: content
Child field(s):
FieldTypeReqKeyDescriptionComments
schemareferencefalse
examplesobjectfalse
encodingobjectfalse
2.15.2.2.6.1.3.4.2 application/xml properties
PropertyValue
Name application/xml
Activated true
Description
Comments
example
Type media
extensions
2.15.2.2.6.1.3.5 Field schema
2.15.2.2.6.1.3.5.1 schema properties
PropertyValue
Name schema
Technical name
Activated true
Reference type model
Reference description
2.15.2.2.6.1.3.6 Field examples
2.15.2.2.6.1.3.6.1 examples properties
PropertyValue
Name examples
Technical name examples
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.15.2.2.6.1.3.7 Field encoding
2.15.2.2.6.1.3.7.1 encoding properties
PropertyValue
Name encoding
Technical name encoding
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.15.2.2.6.1.3.8 Field application/json
2.15.2.2.6.1.3.8.1 application/json Hierarchy
Parent field: content
Child field(s):
FieldTypeReqKeyDescriptionComments
schemareferencefalse
examplesobjectfalse
encodingobjectfalse
2.15.2.2.6.1.3.8.2 application/json properties
PropertyValue
Name application/json
Activated true
Description
Comments
example
Type media
extensions
2.15.2.2.6.1.3.9 Field schema
2.15.2.2.6.1.3.9.1 schema properties
PropertyValue
Name schema
Technical name
Activated true
Reference type model
Reference description
2.15.2.2.6.1.3.10 Field examples
2.15.2.2.6.1.3.10.1 examples properties
PropertyValue
Name examples
Technical name examples
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.15.2.2.6.1.3.11 Field encoding
2.15.2.2.6.1.3.11.1 encoding properties
PropertyValue
Name encoding
Technical name encoding
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.15.2.2.6.1.3.12 Field links
2.15.2.2.6.1.3.12.1 links properties
PropertyValue
Name links
Technical name links
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.15.2.2.6.1.4 200 JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "200",
    "description": "successful operation",
    "properties": {
        "response": {
            "type": "object",
            "description": "successful operation",
            "properties": {
                "headers": {
                    "type": "object",
                    "title": "headers",
                    "additionalProperties": false
                },
                "content": {
                    "type": "object",
                    "title": "content",
                    "properties": {
                        "application/xml": {
                            "type": "object",
                            "properties": {
                                "schema": {
                                    "$ref": "#model/definitions/schemas/properties/User"
                                },
                                "examples": {
                                    "type": "object",
                                    "title": "examples",
                                    "additionalProperties": false
                                },
                                "encoding": {
                                    "type": "object",
                                    "title": "encoding",
                                    "additionalProperties": false
                                }
                            },
                            "additionalProperties": false
                        },
                        "application/json": {
                            "type": "object",
                            "properties": {
                                "schema": {
                                    "$ref": "#model/definitions/schemas/properties/User"
                                },
                                "examples": {
                                    "type": "object",
                                    "title": "examples",
                                    "additionalProperties": false
                                },
                                "encoding": {
                                    "type": "object",
                                    "title": "encoding",
                                    "additionalProperties": false
                                }
                            },
                            "additionalProperties": false
                        }
                    },
                    "additionalProperties": false
                },
                "links": {
                    "type": "object",
                    "title": "links",
                    "additionalProperties": false
                }
            },
            "additionalProperties": false
        }
    },
    "additionalProperties": true
}
2.15.2.2.6.1.5 200 JSON data
{
    "response": {
        "headers": {},
        "content": {
            "application/xml": {
                "schema": {
                    "id": 42,
                    "username": "Lorem",
                    "firstName": "Lorem",
                    "lastName": "Lorem",
                    "email": "Lorem",
                    "password": "Lorem",
                    "phone": "Lorem",
                    "userStatus": -23
                },
                "examples": {},
                "encoding": {}
            },
            "application/json": {
                "schema": {
                    "id": -37,
                    "username": "Lorem",
                    "firstName": "Lorem",
                    "lastName": "Lorem",
                    "email": "Lorem",
                    "password": "Lorem",
                    "phone": "Lorem",
                    "userStatus": 62
                },
                "examples": {},
                "encoding": {}
            }
        },
        "links": {}
    }
}
2.15.2.2.6.2 Response 400
2.15.2.2.6.2.1 400 Tree Diagram
2.15.2.2.6.2.2 400 Properties
PropertyValue
Response400
Activatedtrue
Id
$ref
Description

Invalid username supplied

Resources/users/{username}
Parent requestget
Child response
Comments
extensions
[1] pattern
value
2.15.2.2.6.2.3 400 Fields
FieldTypeReqKeyDescriptionComments
responseresponsefalse

Invalid username supplied

headersobjectfalse
contentobjectfalse
linksobjectfalse
2.15.2.2.6.2.3.1 Field response
2.15.2.2.6.2.3.1.1 response Hierarchy
Parent field: 400
Child field(s):
FieldTypeReqKeyDescriptionComments
headersobjectfalse
contentobjectfalse
linksobjectfalse
2.15.2.2.6.2.3.1.2 response properties
PropertyValue
Type response
Comments
Description

Invalid username supplied

extensions
2.15.2.2.6.2.3.2 Field headers
2.15.2.2.6.2.3.2.1 headers properties
PropertyValue
Name headers
Technical name headers
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.15.2.2.6.2.3.3 Field content
2.15.2.2.6.2.3.3.1 content properties
PropertyValue
Name content
Technical name content
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.15.2.2.6.2.3.4 Field links
2.15.2.2.6.2.3.4.1 links properties
PropertyValue
Name links
Technical name links
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.15.2.2.6.2.4 400 JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "400",
    "description": "Invalid username supplied",
    "properties": {
        "response": {
            "type": "object",
            "description": "Invalid username supplied",
            "properties": {
                "headers": {
                    "type": "object",
                    "title": "headers",
                    "additionalProperties": false
                },
                "content": {
                    "type": "object",
                    "title": "content",
                    "additionalProperties": false
                },
                "links": {
                    "type": "object",
                    "title": "links",
                    "additionalProperties": false
                }
            },
            "additionalProperties": false
        }
    },
    "additionalProperties": true
}
2.15.2.2.6.2.5 400 JSON data
{
    "response": {
        "headers": {},
        "content": {},
        "links": {}
    }
}
2.15.2.2.6.3 Response 404
2.15.2.2.6.3.1 404 Tree Diagram
2.15.2.2.6.3.2 404 Properties
PropertyValue
Response404
Activatedtrue
Id
$ref
Description

User not found

Resources/users/{username}
Parent requestget
Child response
Comments
extensions
[1] pattern
value
2.15.2.2.6.3.3 404 Fields
FieldTypeReqKeyDescriptionComments
responseresponsefalse

User not found

headersobjectfalse
contentobjectfalse
linksobjectfalse
2.15.2.2.6.3.3.1 Field response
2.15.2.2.6.3.3.1.1 response Hierarchy
Parent field: 404
Child field(s):
FieldTypeReqKeyDescriptionComments
headersobjectfalse
contentobjectfalse
linksobjectfalse
2.15.2.2.6.3.3.1.2 response properties
PropertyValue
Type response
Comments
Description

User not found

extensions
2.15.2.2.6.3.3.2 Field headers
2.15.2.2.6.3.3.2.1 headers properties
PropertyValue
Name headers
Technical name headers
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.15.2.2.6.3.3.3 Field content
2.15.2.2.6.3.3.3.1 content properties
PropertyValue
Name content
Technical name content
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.15.2.2.6.3.3.4 Field links
2.15.2.2.6.3.3.4.1 links properties
PropertyValue
Name links
Technical name links
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.15.2.2.6.3.4 404 JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "404",
    "description": "User not found",
    "properties": {
        "response": {
            "type": "object",
            "description": "User not found",
            "properties": {
                "headers": {
                    "type": "object",
                    "title": "headers",
                    "additionalProperties": false
                },
                "content": {
                    "type": "object",
                    "title": "content",
                    "additionalProperties": false
                },
                "links": {
                    "type": "object",
                    "title": "links",
                    "additionalProperties": false
                }
            },
            "additionalProperties": false
        }
    },
    "additionalProperties": true
}
2.15.2.2.6.3.5 404 JSON data
{
    "response": {
        "headers": {},
        "content": {},
        "links": {}
    }
}
2.15.2.3 Request put
2.15.2.3.1 put Tree Diagram
2.15.2.3.2 put Properties
PropertyValue
Request operationput
Activatedtrue
Id
$ref
Description

This can only be done by the logged in user.

Resources/users/{username}
Parent request
Child response
Comments
tags
[1] tagusers
summaryUpdated user
externalDocs
[1] url
description
extensions
operationIdupdateUser
deprecated
security
[1] pattern {name}
operation
servers
[1] url
description
variables
extensions
extensions
[1] pattern
value
2.15.2.3.3 put Fields
FieldTypeReqKeyDescriptionComments
parametersarrayfalse
[0] usernameparameter (path)true

name that need to be updated

schemastringfalse
contentobjectfalse
examplesobjectfalse
requestBodyrequestBodytrue

Updated user object

application/jsonmediafalse
schemaobjectfalse
idint64false
usernamestringfalse
firstNamestringfalse
lastNamestringfalse
emailstringfalse
passwordstringfalse
phonestringfalse
userStatusint32false

User Status

examplesobjectfalse
encodingobjectfalse
callbacksoperationObjectfalse
2.15.2.3.3.1 Field parameters
2.15.2.3.3.1.1 parameters Hierarchy
Parent field: put
Child field(s):
FieldTypeReqKeyDescriptionComments
[0] usernameparameter (path)true

name that need to be updated

2.15.2.3.3.1.2 parameters properties
PropertyValue
Name parameters
Technical name parameters
Id
Type array
Title
Description
Required
Min items
Max items
Unique items
Additional items true
Comments
2.15.2.3.3.2 Field [0] username
2.15.2.3.3.2.1 [0] username Hierarchy
Parent field: parameters
Child field(s):
FieldTypeReqKeyDescriptionComments
schemastringfalse
contentobjectfalse
examplesobjectfalse
2.15.2.3.3.2.2 [0] username properties
PropertyValue
Display name username
Activated true
Parameter name username
Type parameter (path)
Description

name that need to be updated

Comments
Required true
Deprecated
Allow empty value
Style
Explode
Allow Reserved
example
extensions
2.15.2.3.3.3 Field schema
2.15.2.3.3.3.1 schema properties
PropertyValue
Name schema
Technical name
Activated true
Id
Type string
Format
Title
Description
Required
Deprecated
Default
Min length
Max length
Pattern
Enum
Faker function
example (deprecated)
nullable
readOnly
writeOnly
xml
externalDocs
Comments
2.15.2.3.3.4 Field content
2.15.2.3.3.4.1 content properties
PropertyValue
Name content
Technical name content
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.15.2.3.3.5 Field examples
2.15.2.3.3.5.1 examples properties
PropertyValue
Name examples
Technical name examples
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.15.2.3.3.6 Field requestBody
2.15.2.3.3.6.1 requestBody Hierarchy
Parent field: put
Child field(s):
FieldTypeReqKeyDescriptionComments
application/jsonmediafalse
2.15.2.3.3.6.2 requestBody properties
PropertyValue
Name requestBody
Technical name
Comments
Type requestBody
Required true
Description

Updated user object

extensions
2.15.2.3.3.7 Field application/json
2.15.2.3.3.7.1 application/json Hierarchy
Parent field: requestBody
Child field(s):
FieldTypeReqKeyDescriptionComments
schemareferencefalse
examplesobjectfalse
encodingobjectfalse
2.15.2.3.3.7.2 application/json properties
PropertyValue
Name application/json
Activated true
Description
Comments
example
Type media
extensions
2.15.2.3.3.8 Field schema
2.15.2.3.3.8.1 schema properties
PropertyValue
Name schema
Technical name
Activated true
Reference type model
Reference description
2.15.2.3.3.9 Field examples
2.15.2.3.3.9.1 examples properties
PropertyValue
Name examples
Technical name examples
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.15.2.3.3.10 Field encoding
2.15.2.3.3.10.1 encoding properties
PropertyValue
Name encoding
Technical name encoding
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.15.2.3.3.11 Field callbacks
2.15.2.3.3.11.1 callbacks properties
PropertyValue
Name callbacks
Technical name
Type operationObject
2.15.2.3.4 put JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "put",
    "description": "This can only be done by the logged in user.",
    "properties": {
        "parameters": {
            "type": "array",
            "title": "parameters",
            "additionalItems": true,
            "items": {
                "type": "object",
                "description": "name that need to be updated",
                "properties": {
                    "schema": {
                        "type": "string"
                    },
                    "content": {
                        "type": "object",
                        "title": "content",
                        "additionalProperties": false
                    },
                    "examples": {
                        "type": "object",
                        "title": "examples",
                        "additionalProperties": false
                    }
                },
                "additionalProperties": false
            }
        },
        "requestBody": {
            "type": "object",
            "description": "Updated user object",
            "properties": {
                "application/json": {
                    "type": "object",
                    "properties": {
                        "schema": {
                            "$ref": "#model/definitions/schemas/properties/User"
                        },
                        "examples": {
                            "type": "object",
                            "title": "examples",
                            "additionalProperties": false
                        },
                        "encoding": {
                            "type": "object",
                            "title": "encoding",
                            "additionalProperties": false
                        }
                    },
                    "additionalProperties": false
                }
            },
            "additionalProperties": false
        },
        "callbacks": {
            "type": "object",
            "additionalProperties": false
        }
    },
    "additionalProperties": true,
    "required": [
        "requestBody"
    ]
}
2.15.2.3.5 put JSON data
{
    "parameters": [
        {
            "schema": "Lorem",
            "content": {},
            "examples": {}
        }
    ],
    "requestBody": {
        "application/json": {
            "schema": {
                "id": -94,
                "username": "Lorem",
                "firstName": "Lorem",
                "lastName": "Lorem",
                "email": "Lorem",
                "password": "Lorem",
                "phone": "Lorem",
                "userStatus": 8
            },
            "examples": {},
            "encoding": {}
        }
    },
    "callbacks": {}
}
2.15.2.3.6 put Responses:
2.15.2.3.6.1 Response 400
2.15.2.3.6.1.1 400 Tree Diagram
2.15.2.3.6.1.2 400 Properties
PropertyValue
Response400
Activatedtrue
Id
$ref
Description

Invalid user supplied

Resources/users/{username}
Parent requestput
Child response
Comments
extensions
[1] pattern
value
2.15.2.3.6.1.3 400 Fields
FieldTypeReqKeyDescriptionComments
responseresponsefalse

Invalid user supplied

headersobjectfalse
contentobjectfalse
linksobjectfalse
2.15.2.3.6.1.3.1 Field response
2.15.2.3.6.1.3.1.1 response Hierarchy
Parent field: 400
Child field(s):
FieldTypeReqKeyDescriptionComments
headersobjectfalse
contentobjectfalse
linksobjectfalse
2.15.2.3.6.1.3.1.2 response properties
PropertyValue
Type response
Comments
Description

Invalid user supplied

extensions
2.15.2.3.6.1.3.2 Field headers
2.15.2.3.6.1.3.2.1 headers properties
PropertyValue
Name headers
Technical name headers
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.15.2.3.6.1.3.3 Field content
2.15.2.3.6.1.3.3.1 content properties
PropertyValue
Name content
Technical name content
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.15.2.3.6.1.3.4 Field links
2.15.2.3.6.1.3.4.1 links properties
PropertyValue
Name links
Technical name links
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.15.2.3.6.1.4 400 JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "400",
    "description": "Invalid user supplied",
    "properties": {
        "response": {
            "type": "object",
            "description": "Invalid user supplied",
            "properties": {
                "headers": {
                    "type": "object",
                    "title": "headers",
                    "additionalProperties": false
                },
                "content": {
                    "type": "object",
                    "title": "content",
                    "additionalProperties": false
                },
                "links": {
                    "type": "object",
                    "title": "links",
                    "additionalProperties": false
                }
            },
            "additionalProperties": false
        }
    },
    "additionalProperties": true
}
2.15.2.3.6.1.5 400 JSON data
{
    "response": {
        "headers": {},
        "content": {},
        "links": {}
    }
}
2.15.2.3.6.2 Response 404
2.15.2.3.6.2.1 404 Tree Diagram
2.15.2.3.6.2.2 404 Properties
PropertyValue
Response404
Activatedtrue
Id
$ref
Description

User not found

Resources/users/{username}
Parent requestput
Child response
Comments
extensions
[1] pattern
value
2.15.2.3.6.2.3 404 Fields
FieldTypeReqKeyDescriptionComments
responseresponsefalse

User not found

headersobjectfalse
contentobjectfalse
linksobjectfalse
2.15.2.3.6.2.3.1 Field response
2.15.2.3.6.2.3.1.1 response Hierarchy
Parent field: 404
Child field(s):
FieldTypeReqKeyDescriptionComments
headersobjectfalse
contentobjectfalse
linksobjectfalse
2.15.2.3.6.2.3.1.2 response properties
PropertyValue
Type response
Comments
Description

User not found

extensions
2.15.2.3.6.2.3.2 Field headers
2.15.2.3.6.2.3.2.1 headers properties
PropertyValue
Name headers
Technical name headers
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.15.2.3.6.2.3.3 Field content
2.15.2.3.6.2.3.3.1 content properties
PropertyValue
Name content
Technical name content
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.15.2.3.6.2.3.4 Field links
2.15.2.3.6.2.3.4.1 links properties
PropertyValue
Name links
Technical name links
Id
Type object
Title
Description
Required
Min Properties
Max Properties
AdditionalProp Control Boolean
Additional Properties false
Comments
2.15.2.3.6.2.4 404 JSON Schema
{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "404",
    "description": "User not found",
    "properties": {
        "response": {
            "type": "object",
            "description": "User not found",
            "properties": {
                "headers": {
                    "type": "object",
                    "title": "headers",
                    "additionalProperties": false
                },
                "content": {
                    "type": "object",
                    "title": "content",
                    "additionalProperties": false
                },
                "links": {
                    "type": "object",
                    "title": "links",
                    "additionalProperties": false
                }
            },
            "additionalProperties": false
        }
    },
    "additionalProperties": true
}
2.15.2.3.6.2.5 404 JSON data
{
    "response": {
        "headers": {},
        "content": {},
        "links": {}
    }
}